Skip to content
This repository was archived by the owner on Mar 3, 2023. It is now read-only.

Commit db255f4

Browse files
removing symlink. Adding contributing guidelines back (#3450)
* removing symlink. Adding contributing guidelines back * clean up
1 parent 783581b commit db255f4

File tree

1 file changed

+74
-1
lines changed

1 file changed

+74
-1
lines changed

CONTRIBUTING.md

-1
This file was deleted.

CONTRIBUTING.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
<!--
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
## Contributing to Heron
21+
22+
Discussion about Heron happens on GitHub and over the mailing list.
23+
24+
* GitHub: [apache/incubator-heron](https://github.com/apache/incubator-heron)
25+
* Heron User Group: [[email protected]](https://mail-archives.apache.org/mod_mbox/heron-user/)
26+
27+
Community is critical to Heron. Contributions are welcomed!
28+
29+
30+
## How Can I Contribute to Heron?
31+
32+
You can first read the following pages to have a basic understanding
33+
of Heron:
34+
35+
* [Heron Architecture](https://heron.incubator.apache.org/docs/heron-architecture/)
36+
* [Compiling Heron](https://heron.incubator.apache.org/docs/compiling-overview/)
37+
* [Heron Codebase](https://heron.incubator.apache.org/docs/compiling-code-organization/)
38+
39+
Heron includes a script to bootstrap an IntelliJ IDEA project. The project includes support for Heron
40+
code styles and copyright headers.
41+
42+
To bootstrap an IDEA project run the following from the root folder of the repo::
43+
44+
```bash
45+
$ ./scripts/setup-intellij.sh
46+
```
47+
To bootstrap an Eclipse project fun the following from the root folder of the repo:
48+
49+
```bash
50+
$ ./scripts/setup-eclipse.sh
51+
```
52+
53+
In general, contributions that fix bugs or add features (as opposed to stylistic, refactoring, or
54+
"cleanup" changes) are preferred. If you're looking for places to contribute, issues with label
55+
[help-wanted](https://github.com/apache/incubator-heron/issues?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted)
56+
are good candidates. Please check with the [mailing list](https://mail-archives.apache.org/mod_mbox/heron-dev/)
57+
if your patch involves lots of changes.
58+
59+
**If you have any question or issues about troubleshooting**,
60+
you should post on [mailing list](https://mail-archives.apache.org/mod_mbox/heron-user/) instead
61+
of opening GitHub issues.
62+
63+
### Submitting a Patch
64+
1. Discuss your plan and design, and get agreement on
65+
[mailing list](https://mail-archives.apache.org/mod_mbox/heron-dev/).
66+
67+
2. Implement proper unit tests along with your change. Verify that all tests can pass.
68+
69+
3. Submit a GitHub pull request that includes your change and test cases.
70+
Describe clearly in your pull request the changes made. Verify that Travis CI passes.
71+
72+
4. Complete a code review by addressing the reviewer's comments.
73+
74+
5. A project committer will merge the patch to the master branch.

0 commit comments

Comments
 (0)