Contributing guide

Contributing to admiral

Community

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our FAQ.

Before you start to code, we recommend discussing your plans through a GitHub issue or discuss it first with the official project maintainers via the gitter.im chat or project-admiral forum, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

Getting Started

Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

• Create a topic branch from where you want to base your work
• Make commits of logical units
• Make sure your commit messages are in the proper format (see below)
• Push your changes to a topic branch in your fork of the repository
• Submit a pull request

Example:

git checkout -b my-new-feature admiral/master
git commit -a
git push $USER my-new-feature

Staying In Sync With Upstream

When your branch gets out of sync with the admiral/master branch, use the following to update:

git checkout my-new-feature
git fetch -a
git rebase admiral/master
git push --force-with-lease $USER my-new-feature

Updating pull requests

If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into existing commits.

If your pull request contains a single commit or your changes are related to the most recent commit, you can simply amend the commit.

git add .
git commit --amend
git push --force-with-lease $USER my-new-feature

If you need to squash changes into an earlier commit, you can use:

git add .
git commit --fixup <commit>
git rebase -i --autosquash admiral/master
git push --force-with-lease $USER my-new-feature

Be sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a notification when you git push.

Code Style

Formatting Commit Messages

We follow the conventions on How to Write a Git Commit Message.

Be sure to include any related GitHub issue references in the commit message. See GFM syntax for referencing issues and commits.

Reporting Bugs and Creating Issues

When opening a new issue, try to roughly follow the commit message format conventions above.