Skip to content

Latest commit

 

History

History
19 lines (12 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

19 lines (12 loc) · 1.56 KB

Contributing to Stanza

We would love to see contributions to Stanza from the community! Contributions that we welcome include bugfixes and enhancements. If you want to report a bug or suggest a feature but don't intend to fix or implement it by yourself, please create a corresponding issue on our issues page. If you plan to contribute a bugfix or enhancement, please read the following.

🛠️ Bugfixes

For bugfixes, please follow these steps:

  • Make sure a fix does not already exist, by searching through existing issues (including closed ones) and pull requests.
  • Confirm the bug with us by creating a bug-report issue. In your issue, you should at least include the platform and environment that you are running with, and a minimal code snippet that will reproduce the bug.
  • Once the bug is confirmed, you can go ahead with implementing the bugfix, and create a pull request against the dev branch.

💡 Enhancements

For enhancements, please follow these steps:

  • Make sure a similar enhancement suggestion does not already exist, by searching through existing issues.
  • Create a feature-request issue and discuss about this enhancement with us. We'll need to make sure this enhancement won't break existing user interface and functionalities.
  • Once the enhancement is confirmed with us, you can go ahead with implementing it, and create a pull request against the dev branch.