-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of github.com:iankressin/hazna-gui into main
- Loading branch information
Showing
2 changed files
with
61 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Contributing to Hana | ||
|
||
Hana is an open-source project. Contribution is welcomed, encouraged and appreciated. | ||
|
||
## How can I contribute? | ||
|
||
There are multiple ways in which you can contribute to Hana: | ||
|
||
* Found a bug? Report it to us! | ||
* Caught a typo in documentation or want to make it better to understand? Edit it! | ||
* Know how to fix an issue or add a new feature? Make a patch! | ||
* If you liked this project, share it with your friends! | ||
|
||
## Reporting Issues | ||
|
||
### You have a problem | ||
|
||
Before opening a new issue, please search for any open issue that already covers your problem. | ||
|
||
If you find one, comment on it so we can know there are more people experiencing it | ||
|
||
If not, you can go ahead and create an issue with as much detail as you can provide: | ||
|
||
1. How to reproduce the problem | ||
2. What the correct behavior should be | ||
3. What the actual behavior is | ||
|
||
We will do our very best to help you. | ||
|
||
### You have a suggestion | ||
|
||
Before opening a new issue, please search for any open issue that already covers your suggestion. | ||
|
||
If you find one, comment on it so we can know that threre are more people supporting it. | ||
|
||
If not, you can create an issue. | ||
|
||
## Submitting Pull Requests | ||
|
||
### Getting Started | ||
|
||
You should be familiar with the basics of contributing on GitHub and have a fork properly set up. | ||
|
||
If you create your own PR, please make sure you do it right. Also be so kind as to reference any issue that would be solved in the PR description body, for instance "Fixes #XXXX" for issue number XXXX. | ||
|
||
### You have a solution | ||
|
||
Please, check if there is any open issue already covering your problem, and any pending/merged/rejected PR covering your solution. | ||
|
||
If the solution is already reported, try it out and +1 the PR if the solution works ok. On the other hand, if you think your solution is better, post it with a reference to the other one so we can have both solutions to compare. | ||
|
||
If not, then go ahead and submit a PR. | ||
|
||
### You have an addition | ||
|
||
Please be so kind as to search for any pending, merged or rejected PRs covering or related to what you want to add. | ||
|
||
If you find one, try it out and work with the author on a common solution. | ||
|
||
If not, then go ahead and submit a PR. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters