moved section on contributing code to cwiki. A link to the cwiki page is now included. Also added a link to the wishlist for the project on JIRA
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/2f682cd9 Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/2f682cd9 Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/2f682cd9 Branch: refs/heads/master Commit: 2f682cd9e644ff85bdcc4e069cb356e09b3eddb9 Parents: 5e6aa5b Author: aditihilbert <[email protected]> Authored: Fri Nov 11 16:30:50 2016 -0800 Committer: aditihilbert <[email protected]> Committed: Fri Nov 11 16:52:29 2016 -0800 ---------------------------------------------------------------------- custom-theme/community.html | 41 +++++++--------------------------------- 1 file changed, 7 insertions(+), 34 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2f682cd9/custom-theme/community.html ---------------------------------------------------------------------- diff --git a/custom-theme/community.html b/custom-theme/community.html index ac3e094..9fa2da7 100644 --- a/custom-theme/community.html +++ b/custom-theme/community.html @@ -48,46 +48,19 @@ <div class="row"> <div class="col-md-12"> - <h3>Contributing</h3> - <p> - <font color="#F2853F"> Getting involved is easy! Simply send an email to the dev@ mailing list introducing yourself, and the people in the community can help you get familiar with Apache Mynewt OS. </font> </p> - <p> - If you are already settled in and wish to contribute code, read on ahead. This project strives to adhere to Apache's proposed workflow as explained <a href="https://git-wip-us.apache.org/docs/workflow.html";>here</a>. Basically, you submit your initial edits for your peers to review and merge. After a few successful patches under your belt, you will get access to commit code directly to the module you are working on in the repository. And over time, you will get full access to all the repositories, where you can commit code to any module on the apache git repository (and not the github mirror). </p> - <p>The diagram below explains the recommended process for submitting code to the core repository of Apache Mynewt. The "develop" branch on Mynewt's repository contains the most recent changes made by the community of developers. Contributions from you need to go into this branch. The essential steps are the following: </p> - <ol> - <li> Fork the Mynewt repository to create your very own repo on github. </li> - <li> Clone the Mynewt repository on your machine using the Newt tool. Set up the remotes correctly as shown in the diagram. This is key to making sure you correctly pull the latest code from Mynewt's "develop" and push to your working branch on github. </li> - <li> Make your code changes and commit them locally. </li> - <li> Always sync up with the latest code in the "develop" branch and resolve any merge conflicts. </li> - <li> Push your commits to your working branch on github. - <li> Submit a pull request to the `develop` branch of the appropriate Apache Mynewt repository by clicking the green "New pull request" button on your github fork page. </li> - </ol> + <h3>Getting involved</h3> - <br> + <p> It is easy! Simply send an email to the dev@ mailing list introducing yourself and the Apache Mynewt community will welcome you. If you have questions, sending an email to this list is the fastest way of getting an answer. </p> - <object data="/img/mynewt_dev_cycle.pdf" type="application/pdf" width=900 height=750> - <p><b>Example fallback content</b>: This browser does not support PDFs. Please download the PDF to view it: <a href="/img/mynewt_dev_cycle.pdf"> Download PDF </a>.</p> - </object> + <p> If you want to browse the code, <a href="https://github.com/apache/incubator-mynewt-core/tree/develop";>Mynewt Core Repo</a> is the best place to start. - <br> - - <p> Remember there are three repositories to work with in the Apache Mynewt project. All of them have a "develop" branch which contains the latest code. The code from "develop" is merged periodically into "master" on all these repositories and releases are then tagged off the "master" branch. - <ul> - <li><a href="https://github.com/apache/incubator-mynewt-core";>Apache Mynewt core repo mirrored on github</a></li> - <li><a href="https://github.com/apache/incubator-mynewt-newt";>Apache Mynewt newt tool repo mirrored on github</a></li> - <li><a href="https://github.com/apache/incubator-mynewt-site";>Apache Mynewt documentation repo mirrored on github</a></li> - </ul> - <br> - <p> <mark>The bottomline is to work with the "develop" branch. </mark> It has the latest code and you want your changes tested, working, and merged with that codebase. In the comment for the pull request, include a description of the changes you have made and why. Github will automatically notify everyone on the [email protected] mailing list about the newly opened pull requests. You can open a pull request even if you don't think the code is ready for merging but want some discussion on the matter. </p> - <p> <mark>There is no need to open a new pull request if you have already submitted a pull request against the "develop" branch on the mirror but have modified your code futher </mark>(e.g. after some feedback from the community or another clever idea popping into your head). The old pull request will get updated with your changes.</p> - <p> Upon receiving notification, one or more committers will review your work, ask for edits or clarifications, and merge when your proposed changes are ready.</p> - - </p> - <p> To know more check out the FAQ in Appendix under <a href="https://mynewt.apache.org/faq/answers/";>Documentation.</a></p> - <br> + <p> If you wish to contribute code, a quick look at the <a href="https://cwiki.apache.org/confluence/display/MYNEWT/Contributing+to+Apache+Mynewt";> recommended steps </a> should help. <h3>Bug Submission and Issue Tracking</h3> <p>Issues, features, improvements, and wish-lists are tracked using <a href="https://issues.apache.org/jira/browse/Mynewt/";>ASF JIRA</a>, the Atlassian JIRA software on Apache Software Foundation </p> + <li> + <p><a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20MYNEWT%20AND%20fixVersion%20%3D%20WISHLIST%20ORDER%20BY%20updated%20DESC%2C%20priority%20DESC%2C%20created%20ASC";>Click here to see WISHLIST for Mynewt</a></p> + </li> <li> Sign up for an account on JIRA and submit a request to the dev@ mailing list for your JIRA username to be added to the Apache Mynewt (MYNEWT) project. Editing a ticket requires an account. </li>
