| | |
|---|
| | | |
|---|
| | | The following is a set of guidelines for contributing to Open License Manager and its packages, which are hosted in the [Open License Manager organization](https://github.com/open-license-manager) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. |
|---|
| | | |
|---|
| | | ## How Can I Contribute? |
|---|
| | | ## How to Contribute |
|---|
| | | |
|---|
| | | ### Reporting Bugs |
|---|
| | | |
|---|
| | |
|---|
| | | |
|---|
| | | Before creating bug reports, please [check the repository](https://github.com/open-license-manager/open-license-manager/issues) to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). |
|---|
| | | |
|---|
| | | #### How Do I Submit A (Good) Bug Report? |
|---|
| | | #### How to Submit A (Good) Bug Report |
|---|
| | | |
|---|
| | | Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). Explain the problem and include additional details to help maintainers reproduce the problem: |
|---|
| | | |
|---|
| | |
|---|
| | | |
|---|
| | | Please also check for the [current and planned features](https://github.com/open-license-manager/open-license-manager/wiki/features) in the wiki to see where the project is heading to. |
|---|
| | | |
|---|
| | | #### How Do I Submit A (Good) Enhancement Suggestion? |
|---|
| | | #### How to submit a (Good) enhancement suggestion |
|---|
| | | |
|---|
| | | Enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). |
|---|
| | | |
|---|
| | |
|---|
| | | * **Specify the name and version of the OS you're proposing the enhancement for.** If applicable include all the environment informations: is this for running the application in a VM? in a Docker? |
|---|
| | | * **Label the issue as enhancement.** |
|---|
| | | |
|---|
| | | ### Your First Code Contribution |
|---|
| | | ### Your first code contribution |
|---|
| | | |
|---|
| | | Unsure where to begin contributing to Open License Manager? You can start by looking through the [`good first issue`](https://github.com/open-license-manager/open-license-manager/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) and [`help-wanted`](https://github.com/open-license-manager/open-license-manager/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) issues. |
|---|
| | | |
|---|
| | |
|---|
| | | ##### Don't |
|---|
| | | * Don't reformat the code following your personal likes, it introduce a lot of "noise" and makes very hard to merge. Use the clang-format style provided at the base of the project. |
|---|
| | | * Very large pull requests with few comments, no corresponding issue explaining what's it about will probably be rejected. |
|---|
| | | * We understand that the project is still in a very alpha stage, however we would like to discuss it with you before we take project changing decision. Please contact the project maintainer at `contini.mailing[AT]gmail.com` if you have time and plan to do a large contribution. |
|---|
| | | * Even it it's in alpha stage it's used ( _by some really courageous people!_ ) in production. We can't break current functionality, user established habits without documenting the change. |
|---|
| | | * We understand that the project is still in beta stage, however we would like to discuss it with you before we take project changing decision. Please contact the project maintainer at `contini.mailing[AT]gmail.com` if you have time and plan to do a large contribution. |
|---|
| | | * Even it it's in beta stage it's used ( _by some really courageous people!_ ) in production. We can't break current functionality, user established habits without documenting the change. |
|---|
| | | |
|---|
| | | |
|---|
