Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Cloning or Forking the

...

Repositories

Cloning the RepositoriesThese are the steps to get clone the source code from repository:

Enter inside "nuttx" and, if you like, create a branch where you will work:

  • cd nuttx
  • git checkout -b mybranch origin/dev

REVIST:  Should we not recommend that people use a fork vs. a clone?  Reference: https://help.github.com/en/github/getting-started-with-github/fork-a-repo

Clones are of repositories are useful was of creating patches the you can send to the Apache project for inclusion.  A better workflow, however, would use pull requests and to use pull requests you will need to use a fork instead of a clone.

Make your modification and commit it.

Forking the Reposities:  A fork of the respository is a clone of the origin repository that exists in your remote github user area.  The" fork & pull" model lets anyone fork an existing repository and push changes to their personal fork without requiring access be granted to the source repository.  The changes must then be pulled into the source repository by the project maintainer. This model reduces the amount of friction for new contributors and is popular with open source projects because it allows people to work independently without upfront coordination.

The forked repository is mostly static.  It exists in order to allow you to publish work for code review purposes. You don't do active development in your forked repository (in fact, you can't; because it doesn't exist on your computer, it exists on GitHub's server in the cloud).

To create a fork of your repository, follow these steps (from https://help.github.com/en/github/getting-started-with-github/fork-a-repo):

Create the fork by visting the https://github.com/apache/incubator-nuttx/.  In the upper right corner, there is a button labeled Fork.  Follow the instructions and this will create a repository in your personal area at https://github.com/<username>/incubator-nuttx.

Create a local clone of your fork.  On you local PC execute 'git clone <URL>' to create a clone of your fork on your local PC.  You can find the exact for of that URL by visting https://github.com/<username>/incubator-nuttx and clicking on the Clone or download buttonMake your modification and commit it.

Released Code Tarballs

REVISIT:  We do not know the form or location of future Apache NuttX releases.

...