Welcome to the guide on submitting pull requests to the English community. If you have suggestions for improvements or contributions, this is the place to start!

Why Submit a Pull Request?

Pull requests are the main way we integrate new contributions into the project. By submitting a pull request, you can:

  • Contribute code, documentation, or other resources.
  • Fix bugs or issues reported by others.
  • Improve the project's overall quality and functionality.

How to Create a Pull Request

  1. Fork the Repository: Start by forking the official repository on GitHub to your personal account.
  2. Create a New Branch: From your forked repository, create a new branch for your changes.
  3. Make Your Changes: Implement your changes in the new branch. Make sure to follow the coding standards and guidelines.
  4. Commit Your Changes: Commit your changes and push the branch to your forked repository.
  5. Open a Pull Request: From your forked repository, open a pull request to the original repository. Describe your changes and explain why they are important.

Best Practices

  • Follow the Issue Template: If you're fixing a specific issue, make sure to follow the issue template to provide all necessary information.
  • Write Good Commit Messages: A clear and concise commit message helps others understand the purpose of your changes.
  • Include Tests: If you're making changes to the code, include tests to ensure your changes don't break anything.

Example Pull Request

Here's a sample pull request you can refer to for more details.

Related Resources

GitHub Pull Request