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.
Patches
Apache Mynewt can accept patches as proposed in Apache's workflow here. 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).
Pull Requests
Apache Mynewt will also accept Pull Requests (PR) against its github repositories. We recommend the route of the Pull Request. The steps are given below, followed by an explanatory diagram of how the remote and local repositories interact. The "master" branch is the main branch for code development and "feature" branches handle code for long-lived features that several people in the community collaborate on. An example of a feature branch is "bluetooth5". The master branch is kept fairly up-to-date by merging commits periodically from such "feature" branches into "master". Small changes or edits that are not related to any of these features being tracked in "feature" branches can be merged into the "master" directly without requiring the creation of a "feature" branch.
...
- Fork the Mynewt repository to create your very own repo on github.
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 "master" and push to your working branch on github.
Code Block language text $ newt new devproject $ cd devproject $ newt install $ cd repos/apache-mynewt-core $ git status On branch mynewt_1_0_0_tag nothing to commit, working tree clean $ git checkout -b mybranch Switched to a new branch '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) $ git pull --rebase origin master
If you are working on a long-term feature (and hence using the code in a "feature" branch), then you should create your branch and pull the latest code from that branch instead. Note lines 8 and 20 below:
Code Block linenumbers true $ newt new devproject $ cd devproject $ newt install $ cd repos/apache-mynewt-core $ git status On branch mynewt_1_0_0_tag nothing to commit, working tree clean $ git checkout <feature-branch-name> $ git checkout -b mybranch Switched to a new branch '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) $ git pull --rebase origin <feature-branch-name>
Make your code changes and commit them locally. Do all this in your local branch ("mybranch" in this example).
Code Block $ git checkout mybranch <make your code changes> $ git add . $ git commit –m “your message about your code changes”
Always sync up with the latest code in the "master" branch and resolve any merge conflicts before pushing any changes to remotes. Again, if you are working on a feature branch, always sync up with the "feature" branch.
Code Block $ git pull --rebase origin master OR $ git pull --rebase origin <feature-branch-name>
Push your commits to your remote working branch on github.
Code Block $ git push fork mybranch
- a) Submit a pull request against the "master" branch of the appropriate Apache Mynewt repository (incubator-mynewt-core if you are working on the Mynewt OS codebase, incubator-mynewt-newt if you are working on the Newt Tool) by clicking the green "New pull request" button on your github fork page.
OR
b) Submit a pull request against the appropriate "feature" branch if your changes are for the functionality in the "feature" branch.
Explanatory diagram
If you are working with the master branch:
...