Guidelines for a quality PR

Refer to these guidelines to ensure that you are contributing a quality PR

• Clear and Concise Title:

  Use a descriptive and concise title for your pull request that summarizes the purpose of the changes.

• Detailed Description:

  Provide a clear and detailed description of the changes you have made, explaining the problem you are addressing and how your changes solve it. Include relevant context, motivations, and any necessary background information.

• Small, Atomic Commits:

  Break your changes into small, logical, and atomic commits. Each commit should represent a single, focused change. This makes it easier for reviewers to understand and review your code.

• Code Quality and Formatting:

  Ensure that your code follows consistent formatting and adheres to the coding style guidelines of the project. Use proper indentation, naming conventions, and coding best practices. Run lines and automated code formatting tools if they are available.

• Testing and Test Coverage:

  Write tests for your code changes to ensure their correctness and maintainability. Strive for high test coverage to validate the behaviour of your changes. Include instructions for running the tests in your pull request description.

• Documentation Updates:

  Update the project documentation, including code comments, README files, or any relevant documentation files, to reflect your changes. This helps other contributors and users understand the functionality and usage of your code.

• Pull Request Reviews:

  Be open to feedback and participate in the review process. Address any review comments promptly and thoughtfully. Engage in constructive discussions to improve the quality of your code.

• Avoiding Dependencies and Conflicts:

  Ensure that your pull request does not introduce unnecessary dependencies or conflicts with existing code. Resolve any merge conflicts before submitting your pull request.

• Clear and Helpful Messages:

  Use clear and helpful commit messages and comments in your code. This makes it easier for other contributors to understand your intentions and the reasoning behind your changes.

• Compliance with Project Guidelines:

  Familiarize yourself with the project's contributing guidelines, coding standards, and style guide. Ensure that your changes align with these guidelines.