imanhodjaev/pycran

View on GitHub
CONTRIBUTING.md

Summary

Maintainability
Test Coverage
## How to contribute to PyCran

#### **How to format code?**

* Use `make format` and `make link` to format and lint your code before submitting.

#### **Did you find a bug?**

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/imanhodjaev/PyCran/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/imanhodjaev/PyCran/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
* If possible, use the relevant bug report templates to create the issue.

#### **Did you write a patch that fixes a bug?**

* Open a new GitHub pull request with the patch.
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

#### **Do you intend to add a new feature or change an existing one?**

* Suggest your change on GitHub under [Issues](https://github.com/imanhodjaev/PyCran/issues)
* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Thanks! 🌟 🍰 🌟