mirror of
https://github.com/jlengrand/helidon.git
synced 2026-03-10 08:21:17 +00:00
CONTRIBUTING and issuetemplate (#43)
* Add contributing information and issue template
This commit is contained in:
22
.github/issue_template.md
vendored
Normal file
22
.github/issue_template.md
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
|
||||
[//]: # "Please remove these comments"
|
||||
[//]: # "Provide a general summary of the issue in the Title above"
|
||||
|
||||
## Environment Details
|
||||
* Helidon Version:
|
||||
* Helidon SE or Helidon MP
|
||||
* JDK version:
|
||||
* OS:
|
||||
* Docker version (if applicable):
|
||||
|
||||
----------
|
||||
|
||||
## Problem Description
|
||||
[//]: # "Describe the bug in detail highlighting current behavior vs expected behavior"
|
||||
[//]: # "State if the problem is easily reproducible or happens intermittently"
|
||||
[//]: # "Include stack traces or command outputs"
|
||||
|
||||
## Steps to reproduce
|
||||
[//]: # "Step by step instructions to reproduce the problem"
|
||||
[//]: # "Provide sample code/application if relevant"
|
||||
|
||||
41
CONTRIBUTING.md
Normal file
41
CONTRIBUTING.md
Normal file
@@ -0,0 +1,41 @@
|
||||
|
||||
# Contributing to Project Helidon
|
||||
|
||||
We welcome your contributions! There are multiple ways to contribute.
|
||||
|
||||
## Discussion
|
||||
|
||||
Join as at [#helidon-users](https://join.slack.com/t/helidon/shared_invite/enQtNDM1NjU3MjkyNDg2LTFkZTM4NmI3OWUyNjUxYWQ5Njc0NGNiMzY3MTZiZmMwNzAxYmI4YzUzOWNkNzNlZTEwNDRkZGU4YzMzZjhkNTE) and participate in discussions.
|
||||
|
||||
## Issues
|
||||
|
||||
If you hit a bug or have an enhancement request then file a [GitHub issue](https://github.com/oracle/helidon/issues). When filing a bug remember that the better written the bug is, the more likely it is
|
||||
to be fixed. Please include:
|
||||
|
||||
1. Version of Helidon
|
||||
2. Whether you are writing a Helidon SE or MP application
|
||||
3. OS
|
||||
4. Version of Docker or Kubernetes or other sosftware if it's relevant to your issue
|
||||
5. Steps to reproduce
|
||||
|
||||
## Code
|
||||
|
||||
We welcome code contributions, but we need the contributor to sign the
|
||||
[Oracle Contributor Agreement (OCA)](https://www.oracle.com/technetwork/community/oca-486395.html)
|
||||
first.
|
||||
|
||||
The process:
|
||||
|
||||
0. Sign the [OCA](https://www.oracle.com/technetwork/community/oca-486395.html)
|
||||
1. Fork the repo
|
||||
2. Fix an issue or create an issue and fix it
|
||||
3. Create a Pull Request that fixes the issue
|
||||
4. Watch your PR for pipeline results. If there are failures then fix them.
|
||||
5. We will review your PR and merge as appropriate.
|
||||
|
||||
## Code of Contact
|
||||
|
||||
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If
|
||||
you'd like more specific guidelines see the
|
||||
[Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
|
||||
|
||||
26
README.md
26
README.md
@@ -34,15 +34,6 @@ Latest documentation and javadocs are available at <https://helidon.io/docs/late
|
||||
|
||||
See Getting Started at <https://helidon.io>.
|
||||
|
||||
## Bugs and Feedback
|
||||
|
||||
Issues are currently tracked in GitHub, see <https://github.com/oracle/helidon/issues>
|
||||
|
||||
## Communication
|
||||
|
||||
* Slack: [#helidon-users](https://join.slack.com/t/helidon/shared_invite/enQtNDM1NjU3MjkyNDg2LTFkZTM4NmI3OWUyNjUxYWQ5Njc0NGNiMzY3MTZiZmMwNzAxYmI4YzUzOWNkNzNlZTEwNDRkZGU4YzMzZjhkNTE)
|
||||
* Twitter: [@helidon_project](https://twitter.com/helidon_project)
|
||||
|
||||
## Downloads / Accessing Binaries
|
||||
|
||||
There are no Helidon downloads. Just use our Maven releases (GroupID `io.helidon`).
|
||||
@@ -92,13 +83,16 @@ but a couple are handy to use on your desktop to verify your changes.
|
||||
* `copyright.sh`: Run a full copyright check
|
||||
* `checkstyle.sh`: Run a full style check
|
||||
|
||||
## Contributing
|
||||
## Get Help
|
||||
|
||||
We are just getting started, so bear with us while we get the project up and running.
|
||||
We'll have more details about contributing shortly.
|
||||
* Join us on Slack: [#helidon-users](https://join.slack.com/t/helidon/shared_invite/enQtNDM1NjU3MjkyNDg2LTFkZTM4NmI3OWUyNjUxYWQ5Njc0NGNiMzY3MTZiZmMwNzAxYmI4YzUzOWNkNzNlZTEwNDRkZGU4YzMzZjhkNTE)
|
||||
|
||||
We do know that for a pull request to be merged we need the contributor to sign the
|
||||
Oracle Contributor Agreement first. See
|
||||
https://www.oracle.com/technetwork/community/oca-486395.html
|
||||
for details.
|
||||
## Get Involved
|
||||
|
||||
* Learn how to [contribute](CONTRIBUTING.md)
|
||||
* See [issues](https://github.com/oracle/helidon/issues) for issues you can help with
|
||||
|
||||
## Stay Informed
|
||||
|
||||
* Twitter: [@helidon_project](https://twitter.com/helidon_project)
|
||||
* Blog: [OracleDevs on Medium](https://medium.com/oracledevs/search?q=helidon)
|
||||
|
||||
@@ -5,6 +5,7 @@
|
||||
.exe
|
||||
.gif
|
||||
.gitignore
|
||||
.github/
|
||||
.ico
|
||||
.jar
|
||||
.jks
|
||||
@@ -22,6 +23,7 @@
|
||||
jaxb.index
|
||||
/MANIFEST.MF
|
||||
/README
|
||||
/CONTRIBUTING.md
|
||||
/NOTICE.txt
|
||||
/LICENSE.txt
|
||||
/copyright.txt
|
||||
|
||||
Reference in New Issue
Block a user