Project:GURU/Information for Contributors

Prior setup
In order to commit to GURU, you need to have a SSH key (used to access the server) and OpenPGP key (used to sign commits and push certificates). If you don't have OpenPGP key yet, following GLEP 63 rules is recommended. Generating GLEP-63-based OpenPGP keys is a decent guide to creating the key.

Please also make sure to read Certificate of Origin, as you will be required to confirm the acceptance of its terms in every commit. Its purpose is to confirm that your commits do not violate copyright.

Once you're ready, please file an access request, including your real name, preferred e-mail address (used only for indexing SSH keys) and SSH key. For bonus points, you can also include the fingerprint of your OpenPGP key but this is currently not necessary.

Repository/git setup
To clone the repository:

This automatically selects the dev branch. Please commit to this branch, and do not ever commit to master directly.

Using the following settings is recommended:

This, in order:
 * 1) blocks git pull from creating merge commits when you have local commits
 * 2) enables automatic rebasing on git pull (eq: git pull --rebase )
 * 3) enables OpenPGP-signing commits (eq: git commit -S )
 * 4) enables OpenPGP-signing push certificates (eq: git push --signed )

Furthermore, you may need to include one of the following if you haven't set them globally already, and the defaults do not work for you:

This, in order:
 * 1) sets the author and committer name (please use your real name)
 * 2) sets the author and committer e-mail address
 * 3) sets the identifier of OpenPGP key to use for signatures

You will also need to include the matching settings in your /etc/portage/make.conf :

This, in order:
 * 1) sets OpenPGP key to be used for committing
 * 2) enables Certificate of Origin signoff, and sets your name and e-mail address for it

Committing
If you haven't used git before, looking through a good guide first is recommended. We recommend the Pro Git Book. GLEP 66 provides recommended Gentoo-specific policies. Long story short, we recommend doing one commit for each change, and starting commit messages with category/package-name: ...

Before committing, please make sure you've staged (via git add ) all your changes correctly. Use the following command to confirm this:

It is recommended to use RepoMan for committing. To commit use:

Alternatively (or whenever direct use of RepoMan is insufficient, please use:

After committing, it is recommended to look through your changes via:

Then push them via: