diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 120000 index d59cc783a21..00000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1 +0,0 @@ -website/content/docs/contributors/community.md \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..0ed694b798e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,74 @@ + + +## Contributing to Heron + +Discussion about Heron happens on GitHub and over the mailing list. + +* GitHub: [apache/incubator-heron](https://github.com/apache/incubator-heron) +* Heron User Group: [user@heron.incubator.apache.org](https://mail-archives.apache.org/mod_mbox/heron-user/) + +Community is critical to Heron. Contributions are welcomed! + + +## How Can I Contribute to Heron? + +You can first read the following pages to have a basic understanding +of Heron: + +* [Heron Architecture](https://heron.incubator.apache.org/docs/heron-architecture/) +* [Compiling Heron](https://heron.incubator.apache.org/docs/compiling-overview/) +* [Heron Codebase](https://heron.incubator.apache.org/docs/compiling-code-organization/) + +Heron includes a script to bootstrap an IntelliJ IDEA project. The project includes support for Heron +code styles and copyright headers. + +To bootstrap an IDEA project run the following from the root folder of the repo:: + +```bash +$ ./scripts/setup-intellij.sh +``` +To bootstrap an Eclipse project fun the following from the root folder of the repo: + +```bash +$ ./scripts/setup-eclipse.sh +``` + +In general, contributions that fix bugs or add features (as opposed to stylistic, refactoring, or +"cleanup" changes) are preferred. If you're looking for places to contribute, issues with label +[help-wanted](https://github.com/apache/incubator-heron/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted) +are good candidates. Please check with the [mailing list](https://mail-archives.apache.org/mod_mbox/heron-dev/) +if your patch involves lots of changes. + +**If you have any question or issues about troubleshooting**, +you should post on [mailing list](https://mail-archives.apache.org/mod_mbox/heron-user/) instead +of opening GitHub issues. + +### Submitting a Patch +1. Discuss your plan and design, and get agreement on +[mailing list](https://mail-archives.apache.org/mod_mbox/heron-dev/). + +2. Implement proper unit tests along with your change. Verify that all tests can pass. + +3. Submit a GitHub pull request that includes your change and test cases. +Describe clearly in your pull request the changes made. Verify that Travis CI passes. + +4. Complete a code review by addressing the reviewer's comments. + +5. A project committer will merge the patch to the master branch. \ No newline at end of file