Title: Contributing to Singularity | Singularity
Domain: singularityware.github.io
| None | IE=edge |
| Contributing to Singularity These docs are for Singularity Version 2.5.2. For older versions, see our archive Contribute to the codeTo contribute to the development of Singularity, you must: Own the code and/or have the right to contribute it Be able to submit software under the 3 clause BSD (or equivalent) license (while other licenses are allowed to be submitted by the license, acceptance of any contribution is up to the project lead) Read, understand and agree to the license Have a GitHub account (this just makes it easier on me)We use the traditional GitHub Flow to develop. This means that you fork the repo and checkout a branch to make changes, you submit a pull request (PR) to the development branch with your changes, and the development branch gets merged with master for official releases. We also have an official CONTRIBUTING document, which also includes a code of conduct.Step 1. Fork the repoTo contribute to the web based documentation, you should obtain a GitHub account and fork the Singularity repository. Once forked, you will want to clone the fork of the repo to your computer. Let’s say my GitHub username is vsoch, and I am using ssh:git clone git@github.com:vsoch/singularity.gitcd singularity/Step 2. Set up your configThe GitHub config file, located at .git/config, is the best way to keep track of many different forks of a repository. I usually open it up right after cloning my fork to add the repository that I forked as a remote, so I can easily get updated from it. Let’s say my .git/config first looks like this, after I clone my own branch: [core] repositoryformatversion = 0 filemode = true bare = false logallrefupdates = true [remote | |
| name | Contributing to Singularity |
| thumbnail | http://singularity.lbl.gov/images/logo/logo.svg |
Links:
Viewport: width=device-width, initial-scale=1
Robots: noindex