Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 2.27 KB

CONTRIBUTE_less.md

File metadata and controls

40 lines (29 loc) · 2.27 KB
Raw

11e-foxhole.com Official Website

Contributing Guide

Thank you for your interest in contributing to this project! We welcome all contributions that help improve the project. Whether you are fixing bugs, adding new features, or improving documentation, we are happy to have your help. If you're not used to play with Github, this guide is for you !

How to Contribute

  1. Fork the project: Click the "Fork" button at the top right of the GitHub page to create your own copy of the project.

  2. Create a branch:

    • Navigate to your forked repository on GitHub.
    • Click on the branch dropdown menu, typically labeled "main" or "master".
    • In the dropdown, type the name of your new branch following the format "feat/" and press "Enter" to create the branch.

  3. Make your changes:

    • In your new branch, navigate to the files you need to modify. For example:
      • Text files used for translation are in src/locales/<lang>/common.json.
      • Images are stored in src/images and will be rendered later in public/images. All images should be in webp format, compressed, and named using the convention imageName-size.webp or imageName-lang-size.webp for locale-specific images.
    • Use GitHub's web-based editor to make changes directly on the site.

  4. Commit your changes:

    • After making your changes, scroll down to the bottom of the page where you edited the file.
    • Add a clear and descriptive commit message in the provided fields, such as "chore: Description of the changes".
    • Select the option to commit directly to your branch or start a pull request.

  5. Open a Pull Request:

    • Once your changes are committed, you can open a Pull Request (PR) from GitHub.
    • Navigate to the "Pull Requests" tab in your forked repository.
    • Click "New Pull Request" and select your branch with the changes.
    • Add a descriptive title and comment about what changes you've made.
    • Submit the PR to have your changes reviewed.

Coding Standards

  • Ensure your code is well-formatted and adheres to the project's conventions.
  • Follow the project's naming conventions and structure.

Communication

If you have any questions or suggestions, feel free to open an issue directly here on the GitHub repository.