forked from helidon-io/helidon-build-tools
-
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.
Update READMEs and add a CONTRIBUTING.md (helidon-io#1079)
- Loading branch information
Showing
4 changed files
with
101 additions
and
0 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,42 @@ | ||
|
||
# Contributing to Project Helidon | ||
|
||
We welcome your contributions! There are multiple ways to contribute. | ||
|
||
## Discussion | ||
|
||
Join us at [#helidon-users](http://slack.helidon.io) and participate in discussions. | ||
|
||
## Opening Issues | ||
|
||
If you hit a bug or have an enhancement request then file a [GitHub issue](https://github.com/oracle/helidon-build-tools/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 software if it's relevant to your issue | ||
5. Steps to reproduce | ||
|
||
## Contributing Code | ||
|
||
We welcome code contributions, but we need the contributor to sign the | ||
[Oracle Contributor Agreement (OCA)](https://oca.opensource.oracle.com) | ||
first. | ||
|
||
## Pull Request Process | ||
|
||
0. Sign the [OCA](https://oca.opensource.oracle.com) | ||
1. Ensure there is an issue created to track and discuss the fix or enhancement you intend to submit. | ||
1. Fork this repository. | ||
1. Create a branch in your fork to implement the changes. We recommend using the issue number as part of your branch name, e.g. 1234-fixes. | ||
1. Submit the pull request. Do not leave the pull request blank. Explain exactly what your changes are meant to do and provide simple steps on how to validate. your changes. Ensure that you reference the issue you created as well. | ||
1. We will assign the pull request to 2-3 people for review before it is merged | ||
|
||
## Code of Conduct | ||
|
||
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) | ||
|
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
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
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,5 @@ | ||
|
||
## Helidon Maven Plugins | ||
|
||
This directory contains plugins used for both the building of Helidon as well as by end users when building and running Helidon applications. Please see the individual READMEs in each plugin module for details about each plugin. | ||
|