ece7ad05c4
* Add GitHub issue templates for bugs, features, support and PRs Issues are either a bug report, feature request or support request. Labels are automaticaly added to the issues respectively: bug, enhancement, support. The templates suggest using the Slack before opening an issue, but no longer say it is a hard requirement. This might give a more inclusive impression to people reporting who are not Slack users. * List more information that should be provided for new issues
1.4 KiB
Contributing
We greatly value the feedback and contributions of our users.
We keep a distinction between Bugs/Issues, New Features and Support Requests. We also try to minimise the noise in our GitHub Issues stream and prefer having a conversation on SDKMAN Slack before creating new issues, if you are not fully sure how to categorize your request. Simply sign up and join one of the following channels:
- User Issues can be raised in our User Issues channel.
- New Features or Enhancements can be discussed in our CLI Development channel.
The GitHub Issue Tracker provides templates for required informations.
Unfortunately we might simply close any Github Issues that have not followed the requested template.
Pull Requests
Pull Requests are always very welcome, but require a valid GitHub Issue as decribed above. The PR template is to be filled in before submission, ensuring that it is linked back to the Github Issue number by replacing #XXX with the appropriate issue reference.
Each PR should also be accompanied by a passing test(s) proving it's validity (where feasible). The feasibility of the test will emerge in the initial discussions of the issue.