Skip to content

Latest commit

 

History

History
44 lines (32 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

44 lines (32 loc) · 2.27 KB

How to Contribute to This Project

Before anything, make sure you undertand where the issue or enhancement is required.
If there's an issue with the logic or the python application itself, then the issue should be created in the terminal-wiki repository (this repo).
If there's an issue with the snapcraft implementation, then the issue should be raised in the wiki repository.
Reason being, the main application is stored in terminal-wiki and this is being synced periodically to wiki
where a snapcraft.yaml file packages the python application.

for more information, refer the README where I try to break things down for easier understanding.

If there are any doubts or qureries please do not hesistate to reach out.

Did You Find a Bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. 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 behaviour that is not occurring.

Did You Write a Patch That Fixes a Bug?

  • Open a new GitHub pull request with the patch.
    • Fork this project
    • Create your feature branch: git checkout -b my-new-feature
    • Commit your changes: git commit -am 'Add some feature'
    • Push to the branch: git push origin my-new-feature
    • Submit a pull request 🎉
  • 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 as a new issue using the label enhancement, BEFORE you start writing code.

Thanks for contributing! ❤️