diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..6df1648fb --- /dev/null +++ b/CONTRIBUTING.md @@ -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) + diff --git a/README.md b/README.md index 2b860ad4c..67dd1f592 100644 --- a/README.md +++ b/README.md @@ -51,3 +51,31 @@ $ mvn validate -Pcopyright # Cd to the component you want to check $ mvn verify -Pspotbugs ``` + +## Documentation + +* For CLI documentation see [cli/README.md](cli/README.md) +* For maven plugin documentation see [maven-plugins/README.md](maven-plugins/README.md) + +## Contributing + +This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md) + +## License + +Copyright (c) 2017, 2024 Oracle and/or its affiliates. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. + + + diff --git a/cli/README.md b/cli/README.md index 82a6a5d77..68cb25a55 100644 --- a/cli/README.md +++ b/cli/README.md @@ -1,5 +1,31 @@ # Helidon CLI +The Helidon CLI lets you easily create a Helidon project by picking from +a set of archetypes. + +It also supports a developer loop that performs continuous compilation and +application restart, so you can easily iterate over source code changes. + +## Create a New Project + +``` +helidon init +``` + +Then answer the questions. + +## Developer Loop + +``` +cd myproject +helidon dev +``` + +As you make source code changes the project will automatically recompile and +restart your application. + +## Implementation Notes + * **impl**: implementation of the Helidon CLI. Uses `harness`, `codegen` and `plugin` * **harness**: a general purpose CLI harness * **codegen**: annotation processor for `harness` diff --git a/maven-plugins/README.md b/maven-plugins/README.md new file mode 100644 index 000000000..5223d9cff --- /dev/null +++ b/maven-plugins/README.md @@ -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. +