THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Contributing to Eagle doesn't just mean writing code. Helping new users on the mailing list, testing releases, and improving documentation are also welcome. In fact, proposing significant code changes usually requires first gaining experience and credibility within the community by helping in other ways. This is also a guide to becoming an effective contributor.
| Table of Contents |
|---|
Before Making Contribution
Before contributing, you should know that Apache Eagle (incubating) is using
- Mailing list for General Discussion
- User: user@eagle.incubator.apache.org
- Development: dev@eagle.incubator.apache.org
- Issues:issues@eagle.incubator.apache.org
- User: user@eagle.incubator.apache.org
- Github for Code Collaboration: https://github.com/apache/incubator-eagle
- JIRA for Issue and Bug Tracking: https://issues.apache.org/jira/browse/EAGLE
- Website and Wiki for Documentation:
Contributing by Helping Other Users
A great way to contribute to Eagle is to help answer user questions on the user@eagle.incubator.apache.org mailing list. There are always many new Eagle users; taking a few minutes to help answer a question is a very valuable community service.
Contributors should subscribe to this list and follow it in order to keep up to date on what's happening in Eagle. Answering questions is an excellent and visible way to help the community, which also demonstrates your expertise.
Contributing by Reviewing Changes
Changes to Eagle source code are proposed, reviewed and committed via Github (described later) at https://github.com/apache/incubator-eagle/pulls. Anyone can view and comment on active changes here. Reviewing others' changes is a good way to learn how the change process works and gain exposure to activity in various parts of the code. You can help by reviewing the changes and asking questions or pointing out issues -- as simple as typos or small issues of style.
Contributing Documentation Changes
Apache Eagle documentations are mainly host on:
...
- To modify the built-in documentation, edit the Markdown source files in Eagle's repository under https://github.com/apache/incubator-eagle
- To modify or comment eagle wiki at https://cwiki.apache.org/confluence/display/EAG/Eagle
- To modify eagle site at https://eagle.incubator.apache.org/
- To have us add a link to an external tutorial you wrote, simply email the developer mailing list.
Contributing Bug Reports
- File a bug ticket at JIRA system: https://issues.apache.org/jira/browse/EAGLE
- Or send bug report to user mailling list: user@eagle.incubator.apache.org
Contributing Code Changes
| Info | ||
|---|---|---|
| ||
When you contribute code, you affirm that the contribution is your original work and that you license the work to the project under the project's open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so. |
This section to help anyone who want to involve and contribute code to eagle project. Apache site have great documentation on how apache build the community and help the open source project. If one wants to know more detail on how apache works, he/she might want to check http://community.apache.org/.
JIRA
- Search the user@eagle.incubator.apache.org and dev@eagle.incubator.apache.org mailing list archives for related discussions
- Search JIRA for existing issues: https://issues.apache.org/jira/browse/EAGLE
- Proposing a JIRA and pull request is appropriate only when a clear problem or change has been identified.
Pull Request
If you are ready to contribute code change. Here in this page we just focus on a consistent dev process to keep the project run smoothly.
- Find the existing Eagle JIRA that the change pertains to. If confirmed the change is new, create a new JIRA ticket if required with required fields
- Issue Type
- Priority
- Affects Version
- Issue Type
- Fork one's own feature branch from eagle official github (https://github.com/apache/incubator-eagle/)
- Fix bug / Develop feature in the feature branch. One might have multiple
- After development is done, send a github pull request. Like https://github.com/apache/incubator-eagle/pull/19. NOTE: Please make sure the pull request title is in format of EAGLE-${ticket_number} ${ticket_title}, so that ASF bot could help sync the pull request comments to JIRA automatically.
Review Process
The committer should follow below process to review the contribution and merge the code.
...