v01d commented on a change in pull request #1677: URL: https://github.com/apache/incubator-nuttx/pull/1677#discussion_r480214299
########## File path: Documentation/contributing/making-changes.rst ########## @@ -0,0 +1,256 @@ +.. include:: /substitutions.rst +.. _making-changes: + +Making Changes +============== + +If you want to make changes to NuttX, for your own personal use, or to submit them back to project to improve NuttX, +that's easy. For the purposes of this guide, you'll need a `GitHub <https://www.github.com>`_ account, since +the Apache NuttX team uses GitHub. (You could also use git locally, or save your changes to other sites like +`GitLab <https://about.gitlab.com/>`_ or `BitBucket <https://bitbucket.org>`_, but that's beyond the scope of this +guide). + +Here's how to do it: + +#. Set your git user name and email + + .. code-block:: bash + + $ cd nuttx/ + $ git config --global user.name "Your Name" + $ git config --global user.email "yourname@somedomaincom" + +#. Sign in to GitHub + + If you don't have a `GitHub <https://www.github.com>`_ account, it's free to + sign up. + |br| + |br| + + +#. Fork the Project + + Visit both these links and hit the Fork button in the upper right of the page: + + * `NuttX <https://github.com/apache/incubator-nuttx/>`_ + * `NuttX Apps <https://github.com/apache/incubator-nuttx-apps/>`_ + + +#. Change the Git Remotes + + The git repositories in your project are currently connected to the official NuttX repositories, but you don't + have permission to push software there. But you can push them to your forks, and from there create Pull Requests + if you want to send them to the NuttX project. + + First, remove the current remote, ``origin`` (we'll add it back later): + + .. code-block:: bash + + $ cd nuttx/ + $ # display the remote + $ git remote -v + + You should see something like this: + + .. code-block:: bash + + origin https://github.com/apache/incubator-nuttx.git + + Now, on the GitHub web page for your forked ``incubator-nuttx`` project, copy the clone url – get it by hitting the + green ``Clone or Download`` button in the upper right. Then do this: + + .. code-block:: bash + + $ git remote rm origin + $ git remote add origin <your forked incubator-nuttx project clone url> + $ git remote add upstream https://github.com/apache/incubator-nuttx.git Review comment: Yes I think this is confusing. The instructions would be simpler if the user first clones the fork and then adds upstream remote. Also note, that there is set-url to change remote url. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
