Skip to content

Latest commit

 

History

History
67 lines (40 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

67 lines (40 loc) · 3.34 KB
Raw

Contribution Guidelines

Thanks for considering contributing to Hawqal! We welcome contributions of all kinds, including bug reports, feature requests, and code contributions.

Code of conduct

We have a code of conduct that all contributors are expected to follow. Please make sure you read and understand it before making any contributions. You can find it here: CODE_OF_CONDUCT.md

Reporting bugs or issues

If you find a bug or issue while using Hawqal, please do the following:

  • Search the existing issues to see if it has already been reported.
  • If it has not been reported, create a new issue and include as much detail as possible, including steps to reproduce the issue.
  • If you are able to provide a fix for the issue, please also include details on how you fixed it.

Requesting Features

  • If you have an idea for a new feature that you'd like to see in Hawqal, please open an issue and describe the feature. If possible, please include details about how the feature would be used and any potential benefits.

How to contribute

We welcome code contributions of all kinds! If you'd like to contribute code to Hawqal.

Commit Message Conventions

  • We follow the Conventional Commits format for commit messages. Please make sure to follow this format when committing code.

Code Review and Testing

  • All pull requests should be reviewed by at least one member of the Hawqal team or by collaborators before they merge into the master.

Suggesting new features or enhancements

We welcome suggestions for new features and enhancements to Hawqal. To make a suggestion, please do the following:

  • Search the existing issues to see if it has already been suggested.
  • If it has not been suggested, create a new issue and include as much detail as possible about the feature or enhancement you are suggesting.

Writing or improving documentation

Improving documentation is a great way to contribute to Hawqal. If you see an opportunity to improve the documentation, please feel free to make the changes and submit a pull request.

Submitting code changes or patches

If you would like to submit code changes or patches to Hawqal, please do the following:

  • Fork the repository and create a new branch for your changes.
  • Make your changes, including tests if applicable.
  • Ensure that your code passes all tests and follows the coding style guidelines.
  • Submit a pull request from your fork to the main repository.
  • Your pull request will be reviewed by one of the maintainers. If there are any issues, they will be addressed and you may be asked to make additional changes.

License

By contributing to Hawqal, you agree to license your contributions under the LICENSE file.

To run the test cases

python test_hawqal.py