Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: Document code contribution process #39

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,33 @@
# Labitat Ansible

Ansible playbooks for space infrastructure
This repository contains configuration management that controls our infrastructure in the space as well as works as documentation on how it's all set up.

## Contributing

To make this ansible code maximally useful to Labitat even if people come and go, the contribution process follow general OSS contribution patterns.

Basically:

- [Fork this repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) to your own user on Github
- Commit your changes in the forked repository (following [commit message guidelines](#commit-message-guidelines)
- [Create a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) (PR) to labitat/labitat-ansible
- If you're making big changes, feel free to name your PR with [WIP] to indicate it's not ready for review yet.
- Respond to review comments, and implement or communicate about any suggestions.
- Wait for merge

After contributing a few PR's, you are welcome to become a reviewer yourself :).

If it's a small change and you have access, it's OK to run ansible before your PR is reviewed. Just remember to re-run if changes are made.

### Commit message guidelines
Your commit message should answer the following questions:
- What is the problem you're fixing?
- How are you solving it?
- What impact will this have on users / fellow coders?

Additionally, split your changes so that you [solve only one problem per commit](https://www.kernel.org/doc/html/latest/process/submitting-patches.html#split-changes). (tip: use `git add -p` to add lines interactively).

In general, [Linux kernel commit guidelines](https://www.kernel.org/doc/html/latest/process/submitting-patches.html) are a good reference.

## Running ansible

Expand Down