Skip to content

Contribution Guidelines for Abilian SBE

Thank you for your interest in contributing to Abilian SBE! We value the participation of each member of the Python community and want everyone to have an enjoyable and fulfilling experience. Accordingly, everyone who participates in Abilian SBE is expected to show respect and courtesy to other community members at all times.

Ways to Contribute

There are many ways to contribute to this project:

  • Submitting bug reports and feature requests: Please use the GitHub Issues page to report issues and suggest features.
  • Improving the documentation: Enhance or clarify documentation to make it more understandable.
  • Submitting pull requests: Changes to the codebase or documentation can be proposed using pull requests (PRs).

Pull Request Process

  1. Fork and Clone the Repository: Start by forking the repository and then clone it locally to make changes.

  2. Create a New Branch: Make a new branch for your changes. Branch names should be descriptive and reflect the issue/feature being addressed.

  3. Code Conventions: Follow the existing coding conventions in the project. This includes style, formatting, and writing clean, readable code.

  4. Add Tests: If you are adding new functionality, write tests that cover the new code.

  5. Check for Existing Issues or PRs: Before submitting your own, check if there's an existing issue or PR addressing the same problem.

  6. Write Meaningful Commit Messages: Commit messages should clearly describe what the commit does. Reference related issues or PRs if applicable.

  7. Run Tests and Linting: Ensure that all tests pass and that your code adheres to the project's linting standards.

  8. Update Documentation: If you make changes to any code that affects how users interact with the project, update the relevant documentation.

  9. Submit the PR: Push your changes to your fork and submit a pull request back to the main repository. In the PR, describe what the changes do and mention any relevant issue numbers.

  10. Code Review: Once a PR is submitted, maintainers will review it. Be open to feedback and make necessary adjustments.

Questions or Suggestions

Feel free to open an issue in the repository if you have any questions, suggestions, or need guidance regarding contributing.

Again, thanks for your interest in contributing to Abilian SBE. We look forward to your contributions!