Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

37 lines (23 loc) · 1.97 KB
Raw

Contributing

Contributions are always welcome! The project is in active development phase, Improving documentation is always a great place to start. Here's how you can get involved, Review the following guidelines and submit contributions via Pull Request only :

Code of Conduct

Make sure you Read our Code of Conduct before starting.

Pull Requests

  1. Document Changes: Clearly document any changes in behavior. Ensure that the README is updated.

  2. Feature Branches: Create feature branches for your changes. Before submitting a PR, update your rebase to the latest code.

  3. Branching Naming: Follow the standard approach of branch name followed by the feature_type and name for eg : for enhancing contribution it might be enhance/contribution , Make sure your branch name provides a one peak meaning for the feature/ bug you are working on

  4. Submit a single Feature for PR: If you're working on multiple features, submit separate PRs for each.

  5. Submit meaningful commit message : We use commitizen for commits and release, Included in Version Control Docs Install and follow the same approach. Each commit should have a meaningful purpose. If you made multiple intermediate commits, squash them before submitting the PR.

Coding Standards

  1. Python Style Guide: Follow the PEP 8 Python style guide for the backend. Format your code using black.

  2. Commit standards: Follow commitizen Conventional Commit Standards

  3. Documentation Style: Use the NumPy docstrings style to document your code.

  4. Testing: TBD

  5. Version Release: Follow Version Release Documentation on README

Steps

  • File an issue if you find any bugs or have a feature request.
  • Set up a development environment.
  • Fork the repository.
  • Make your changes and submit a pull request.

Version Control

For commit and release, Follow docs