Project:GURU/Information for Contributors

From Gentoo Wiki
Jump to: navigation, search

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 (you will receive bug mail and other comms on this address) 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:

user $git clone -b dev git@git.gentoo.org:repo/proj/guru.git

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:

user $git config --local pull.ff only
user $git config --local pull.rebase preserve
user $git config --local commit.gpgsign 1
user $git config --local push.gpgsign 1

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:

user $git config --local user.name "Your Full Name"
user $git config --local user.email "someone@example.com"
user $git config --local user.signingkey KEY-FINGERPRINT

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 /etc/portage/make.conf:

FILE /etc/portage/make.confRepoman setup for committing
PORTAGE_GPG_KEY='KEY-FINGERPRINT'
DCO_SIGNED_OFF_BY='Your Real Name <someone@example.com>'

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:

user $git status

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

user $repoman commit

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

user $repoman full -d
user $git commit -s

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

user $git log -p

Then push them via:

user $git pull --rebase && git push

Becoming a Trusted Contributor

If you have done some good work for GURU already, and feel like taking more responsibilities, you can become a Trusted Contributor and gain the privilege of reviewing commits and merging them to master. In order to do so, please file a bug requesting ascension. The developers will verify your contributions and grant you Trusted Contributor status.