Welcome to the contributing workflow guide! If you're interested in contributing to our project, this guide will help you understand the process and the steps you need to follow.

Getting Started

  1. Fork the Repository: Before you can start contributing, you need to fork the main repository to your own GitHub account.
  2. Create a Branch: After forking, create a new branch for your contribution. This helps keep the main branch clean and allows us to review your changes easily.
  3. Make Your Changes: Make the necessary changes in your branch. It's a good practice to commit your changes frequently and provide clear commit messages.

Testing

  1. Local Testing: Make sure your changes work as expected on your local machine.
  2. Continuous Integration: Our project uses continuous integration to automatically run tests on your code. Make sure to follow the coding standards and guidelines to pass the tests.

Committing Your Changes

  1. Commit Messages: Write clear and concise commit messages. They should describe what was changed and why.
  2. Pull Requests: Open a pull request from your branch to the main repository. Provide a detailed description of your changes and make sure to mention any relevant issues.

Reviewing Your Pull Request

  1. Code Review: Your pull request will be reviewed by the maintainers. They will check for code quality, adherence to coding standards, and overall contribution.
  2. Feedback: Be prepared to receive feedback and make necessary changes as requested.

Common Issues

  • Merge Conflicts: If there are merge conflicts, it means someone else has made changes to the same part of the code. You will need to resolve these conflicts before your pull request can be merged.
  • Testing Failures: If your pull request fails the tests, you will need to fix the issues and update your pull request.

Resources

For more detailed information, please refer to our Developer Guide.

Code Review