Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 2.29 KB

Contributing to Go Easy i18n

Thank you for considering contributing to Go Easy i18n! Whether it's code or documentation, we appreciate your help. If you have any questions or need clarification on the contribution process, feel free to open an issue. Here are some guidelines to ensure a smooth and efficient contribution process.

Code of Conduct

Before contributing, please read and adhere to our Code of Conduct. We expect all contributors to maintain a respectful and harassment-free environment.

Contribution Process

  1. Fork the Repository:

    • Fork the main repository to your personal GitHub account.

  2. Clone the Repository:

    • Clone your fork to your local machine. 
      git clone https://github.com/[your_username]/goeasyi18n.git

  3. Create a Branch:

    • Create a new branch for your feature or fix. 
      git checkout -b your-branch-name

  4. Make Your Changes:

    • Implement your changes, ensuring you follow the project's best practices and coding styles.

  5. Run Tests:

    • Ensure that all tests pass. If you're introducing a new feature or change, you must provide tests that cover your changes.

  6. Commit and Push:

    • Commit your changes in lowercase and push them to your fork. 
      git add .
git commit -m "brief description of changes"
git push origin your-branch-name

  7. Open a Pull Request (PR):

    • Go to the main repository and click on "New Pull Request". Select your branch and propose the PR.

Best Practices for PRs

  • Clear Description: Provide a detailed description of the changes you are proposing.
  • Related Issues: If your PR relates to an existing issue, make sure to reference it.
  • Small Commits: Try to make small, specific commits; this facilitates review and the merge process.
  • Document Your Changes: If you're introducing a new feature or making significant changes, make sure to update the relevant documentation.

Communication

If you have questions, concerns, or need clarifications, please open an issue. We value community feedback and will try to respond as soon as possible.

Acknowledgments

Thank you for your interest in improving Go Easy i18n! Whether it's through code or documentation, your contribution is invaluable to the community.