← Exit Codelab
⏱ 3 mins remaining

Atmosphere Pro

Learn how to setup your development environment to contribute to Atmosphere Pro

Steps in this module

  1. Introduction
  2. Forking the Repository
  3. Following the Contributing Guidelines
  4. Making Contributions

Following the Contributing Guidelines

Here at Atsign, we LOVE pull requests. You may have been part of various teams & projects where they followed different styles of contributing to GitHub repositories (squash & rebase, or committing to the same branch,..). But here at Atsign, all of our projects, apps, and services are open-sourced and the fork and pull request process seems to work the best for us.

See the CONTRIBUTING.md file in the root of the repository to see how we want you to set up your repository when making contributions. Either read the updated guidelines above, or continue reading below (the steps are roughly the same).

  1. Add a new remote “upstream” to be our version of the repository
git remote add upstream git@github.com:atsign-foundation/atmosphere_pro.git
  1. Set pushing to disabled. This is so you can’t accidentally push to the upstream repository. We want everyone to make pull requests so our developers can review your code and make suggestions.
git remote set-url upstream --push DISABLED
  1. Do git remote -v. If you see something similar to this, then you’ve done it successfully.
origin  git@github.com:yourname/atmosphere_pro.git (fetch)
origin  git@github.com:yourname/atmosphere_pro.git (push)
upstream        git@github.com:atsign-foundation/atmosphere_pro.git (fetch)
upstream        DISABLED (push)
Back
Next