You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/07/18 20:26:57 UTC
incubator-mynewt-site git commit: Code contribution process diagram
and steps added under community page as well as in the appendix under
Documentation
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/master b4131b366 -> f862cc803
Code contribution process diagram and steps added under community page as well as in the appendix under Documentation
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/f862cc80
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/f862cc80
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/f862cc80
Branch: refs/heads/master
Commit: f862cc803ec830485003e954fd41420c5d1592ee
Parents: b4131b3
Author: aditihilbert <ad...@runtime.io>
Authored: Mon Jul 18 13:18:45 2016 -0700
Committer: aditihilbert <ad...@runtime.io>
Committed: Mon Jul 18 13:22:28 2016 -0700
----------------------------------------------------------------------
custom-theme/community.html | 49 ++++++++++++++++-------------
custom-theme/img/mynewt_dev_cycle.pdf | Bin 0 -> 247703 bytes
docs/faq/answers.md | 38 ++++++++++++++++++----
docs/faq/mynewt_dev_cycle.jpg | Bin 0 -> 255157 bytes
4 files changed, 59 insertions(+), 28 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f862cc80/custom-theme/community.html
----------------------------------------------------------------------
diff --git a/custom-theme/community.html b/custom-theme/community.html
index 187daa3..b19b840 100644
--- a/custom-theme/community.html
+++ b/custom-theme/community.html
@@ -65,35 +65,40 @@
<li> Log in and report a bug by choosing the "MYNEWT" project, clicking on the "Create" button, and creating a ticket with an appropriate Issue Type (e.g. Bug, Wish). </p>
<p> If you are a contributor and wish to work on a change, open a JIRA ticket first. It's always a good idea to introduce the change in the dev@ mailing list and refer to that ticket. When you generate a pull request into the github mirror for your change, always reference the JIRA ticket number in the title. JIRA is set up to resolve the ticket when your code is merged into the ASF git repository and the pull request closed. </p>
- <h3>Contributing Code</h3>
+ <h3>Contributing</h3>
<p>
You can start contributing right away, even if you are not a committer on Apache Mynewt! One requirement is that you adhere to the 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>You may choose to submit patches in one of the two following ways:
+ <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>
+
<br>
- <ol>
- <li>
- Fork the mirrored repository to create your very own repo on github. Clone the forked repository into a local branch on your machine. <mark> Either checkout the `develop` branch and make your changes in the develop branch or create a new branch out of `develop` and work there.</mark> Then submit a <mark> pull request to the `develop` branch </mark> on the github mirror of the appropriate Apache Mynewt repository by clicking the green "New pull request" button on your github fork page:
- <ul>
- <br>
- <li><a href="https://github.com/apache/incubator-mynewt-larva">Apache Mynewt larva repo mirrored on github</a></li>
- <br>
+
+ <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>
+
+ <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>
- <br>
<li><a href="https://github.com/apache/incubator-mynewt-site">Apache Mynewt documentation repo mirrored on github</a></li>
- <br>
- </ul>
- <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 commits@mynewt.incubator.apache.org 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> If you have already submitted a pull request against the `develop` branch on the mirror but have modified your code futher (e.g. after some feedback from the community or another clever idea popping into your head) <mark> there is no need to open a new pull request</mark>. The old pull request will get updated with your changes. Always remember to <mark> fetch the latest code from `develop` before committing your changes to the branch.</mark> </p>
+ </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 commits@mynewt.incubator.apache.org 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>
- </li>
- <li>
- Use the `git format-patch` command to produce a patch file. Submit the patch (your code changes along with a diff from the old code) via email to the @dev mailing list. Summarize the issue and your work in the email. Regular project members will review your suggested patch and add it to the repository, acknowledging your contribution by referencing your name in the commit message. </li>
- </ol>
- </p>
- <h3>Contributing to the web site</h3>
- <p> Go to <a href="https://github.com/apache/incubator-mynewt-site">Apache Mynewt documentation repo mirrored on github</a> to clone the repository into a local branch on your machine. Make your changes. Then submit a pull request on the github mirror repository by clicking the green "New pull request" button on the page. </p>
- <p> To know more check out the <a href="http://mynewt.apache.org/faq/how_to_edit_docs/"> Appendix </a>. </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>
</div>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f862cc80/custom-theme/img/mynewt_dev_cycle.pdf
----------------------------------------------------------------------
diff --git a/custom-theme/img/mynewt_dev_cycle.pdf b/custom-theme/img/mynewt_dev_cycle.pdf
new file mode 100644
index 0000000..4e9cb71
Binary files /dev/null and b/custom-theme/img/mynewt_dev_cycle.pdf differ
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f862cc80/docs/faq/answers.md
----------------------------------------------------------------------
diff --git a/docs/faq/answers.md b/docs/faq/answers.md
index 266a3a6..b87d910 100644
--- a/docs/faq/answers.md
+++ b/docs/faq/answers.md
@@ -1,5 +1,7 @@
### How do I submit a bug?
+<br>
+
If you do not have a JIRA account sign up for an account on [JIRA](https://issues.apache.org/jira/secure/Signup!default.jspa).
Submit a request to the @dev mailing list for your JIRA username to be added to the Apache Mynewt (MYNEWT) project. You can view the issues on JIRA for the MYNEWT project without an account but you need to log in for reporting a bug.
@@ -8,6 +10,8 @@ Log in. Choose the "MYNEWT" project. Click on the "Create" button to create a ti
### How do I request a feature?
+<br>
+
If you do not have a JIRA account sign up for an account on [JIRA](https://issues.apache.org/jira/secure/Signup!default.jspa).
Submit a request to the @dev mailing list for your JIRA username to be added to the Apache Mynewt (MYNEWT) project. You can view the issues on JIRA for the MYNEWT project without an account but you need to log in for reporting a bug.
@@ -18,19 +22,39 @@ If you are not a committer and you wish to work on it, someone who is on the com
### I am not on the committer list. How do I submit a patch?
-You submit your proposed changes for your peers with committer status to review and merge.
+<br>
-You may choose to submit patches in one of the two following ways:
+**You submit your proposed changes for your peers with committer status to review and merge.**
-1\. Go to the [Mynewt OS mirror](https://github.com/apache/incubator-mynewt-larva) or [Newt Tool mirror](https://github.com/apache/incubator-mynewt-newt) on github.com, as appropriate. Click on the "Fork" button to create your own instance of the repo on github.com. Clone the forked repository into a local branch on your machine and make your changes. Push that branch to your fork on github. Then submit a pull request from that branch on your github repo.
+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 to setting up your project space for working with the latest code from "develop" and make pull requests into "develop" to get your code added are the following:
-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 commits@mynewt.incubator.apache.org 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.
-Upon receiving notification, one or more committers will review your work, ask for edits or clarifications, and merge when your proposed changes are ready.
-2\.Use the `git format-patch` command to produce a patch file. Submit the patch (your code changes along with a diff from the old code) via email to the @dev mailing list. Summarize the issue and your work in the email. Regular project members will review your suggested patch and add it to the repository, acknowledging your contribution by referencing your name in the commit message.
+**Step 1:** Create a fork of the entire Mynewt repository on github.com.
+**Step 2:** Setup repository on your laptop to use code in \u201cdevelop\u201d branch. You then create a new branch \u201cmybranch\u201d using \u201cgit checkout \u2013b\u201d. You also add a remote handle named \u201cfork\u201d that points to the github fork you created in Step 1.
+``` $ newt new devproject $ cd devproject $ vi project.yml # change version to 0-dev for repository.apache-mynewt-core $ newt install $ cd repos/apache-mynewt-core $ git status On branch develop Your branch is up-to-date with 'origin/develop'. nothing to commit, working directory clean $ git checkout \u2013b mybranch $ git remote -v origin https://github.com/apache/incubator-mynewt-core.git (fetch)
+ origin https://github.com/apache/incubator-mynewt-core.git (push) $ git remote add fork https://github.com/<user>/incubator-mynewt-core
+ $ git remote -v origin https://github.com/apache/incubator-mynewt-core.git (fetch)
+ origin https://github.com/apache/incubator-mynewt-core.git (push) fork https://github.com/<user>/incubator-mynewt-core (fetch)
+ fork https://github.com/<user>/incubator-mynewt-core (push)
+```**Step 3:** Check you are in \u201cmybranch\u201d. Write code. Stage and commit your changes(example shows adding all).
+``` $ git checkout mybranch $ git add . $ git commit \u2013m \u201cyour message about your code changes\u201d
+```
+**Step 4:** Always pull the latest from develop on Apache mirror to \u201cmybranch\u201d before pushing any changes to remotes. If you see merge conflicts, resolve them first.
+``` $ git pull --rebase origin develop
+```
+**Step 5:** Push your changes to \u201cmybranch\u201d branch on your github fork. If \u201cmybranch\u201d does not exist yet on your github fork, the command automa;cally creates it.
+``` $ git push fork mybranch
+```
+**\ufffcStep 6:** Generate a pull request from \u201cmybranch\u201d in your fork to \u201cdevelop\u201d in Mynewt using the "New pull request" button on github.com.
+
+
+
+
### I would like to make some edits to the documentation. What do I do?
+<br>
+
You submit your proposed changes for your peers with committer status to review and merge.
Go to the [documentation mirror](https://github.com/apache/incubator-mynewt-site) on github.com.
@@ -47,6 +71,8 @@ If you want to withdraw the pull request simply go to your fork `https://github.
### I would like to make some edits to the documentation but want to use an editor on my own laptop. What do I do?
+<br>
+
You submit your proposed changes for your peers with committer status to review and merge.
Go to the [documentation mirror](https://github.com/apache/incubator-mynewt-site) on github.com. You need to create your own fork of the repo in github.com by clicking on the "Fork" button on the top right. Clone the forked repository into your laptop (using `git clone` from a terminal or using the download buttons on the github page)and create a local branch for the edits and switching to it (using `git checkout -b <new-branchname>` or GitHub Desktop).
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/f862cc80/docs/faq/mynewt_dev_cycle.jpg
----------------------------------------------------------------------
diff --git a/docs/faq/mynewt_dev_cycle.jpg b/docs/faq/mynewt_dev_cycle.jpg
new file mode 100644
index 0000000..6b4795d
Binary files /dev/null and b/docs/faq/mynewt_dev_cycle.jpg differ