Skip to content

Latest commit

 

History

History
122 lines (74 loc) · 6.61 KB

CONTRIBUTING.md

File metadata and controls

122 lines (74 loc) · 6.61 KB

Contributing to CHAOSS Africa

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

What is this document?

This document outlines a generic process of contributing and applies to all CHAOSS repositories. Each repository may have unique guidelines specific to the project, but this document serves as a primer for what is required when contributing to CHAOSS.
Use your best judgement, and feel free to propose changes to this document in a pull request

Who can contribute?

Anyone can contribute to CHAOSS on any of our communication channels. See https://chaoss.community/participate/ to learn more about how to participate. We are excited to meet first-timers and we are always ready to support you during your contribution journey.

Which channel should I use?

CHAOSS uses the following channels for contributions:

  • Mailing Lists
  • Community calls
  • Working group calls
  • GitHub

Catch us online

Conversations and high-level contributions (email, call, face to face)

Strategic directions, clarifications of scope, and ideas in an early stage are best discussed on the mailing list, calls, and face-to-face meetings. See https://chaoss.community/participate/.

Bug report and feature request contributions (issue)

Bug reports and specific feature requests are best discussed in an issue on the repository they pertain to. You can do this by creating an issue and explaining what bug you found in the comment section. The conversation moves from there.

Code or document change contributions (GitHub User Interface)

Changes can be made from within the GitHub user interface. As a non-maintainer, GitHub will create a fork under your name and ask that you create a pull request. The pull request lets the repository maintainers know of your change and provides a space to discuss the change.

The CHAOSS Charter requires that contributions are accompanied by a Developer Certificate of Origin sign-off.
For ensuring it, a bot checks all incoming commits.

A DCO sign-off is accomplished by writing into the commit comment field:

Signed-off-by: Your Name <[email protected]>

It should be noted that the angled brackets < and > need to be included with the email.

This can be automated by using a browser plugin like DCO GitHub UI.

Steps to use the DCO browser plugin

The DCO browser plugin is a handy tool to automatically sign commits created using GitHub. To enable this plugin:

  • Go to the plugin page on the chrome web store.

  • Alternatively, you could go to the firefox addon page to add the extension to your browser.

  • Once you add the extension, right click on the extension in the toolbar of your browser and select Options.

  • A dialog box will open up as shown below. Fill in your GitHub name (not the handle) and email-id.

  • Then, whenever you perform a commit on GitHub, the line Signed-off-by: Your Name <Youremail> will automatically appear in the commit description while making changes to a file as shown in the example below. A commit message can be added to the lines above the auto-generated sign-off.

  • Once you perform the commit and send a pull request, the commit will be verified and approved by the DCO bot.

This plugin is non-intrusive and works only on GitHub.

If you forget to add the sign-off you can also amend a previous commit with the sign-off. For this, you need to clone the repository on your local machine and run git commit --amend -s. Because you have pushed your changes to GitHub already you'll need to force push your branch after this with git push -f.

Code or document change contributions (pull request)

Changes to source code files or documents are best contributed and discussed in pull requests. Please look at the CONTRIBUTING.md files for repository specifics.

In this process, make sure your GitHub account is setup fork then locally clone the repo:

git clone [email protected]:<your-username>/<repository>.git

Create a feature branch in your local repository:

git checkout -b <branch>

Make your change and commit the change (NOTE: with -s you sign-off on each commit, which is your Developer Certificate of Origin):

git add <changed file>
git commit -s -m "<description of change>"

If you forget to add the sign-off you can also amend a previous commit with the sign-off by running git commit --amend -s. If you have pushed your changes to GitHub already you'll need to force push your branch after this with git push -f.

Push to your fork on GitHub:

git push origin <branch>

Then, submit a pull request on GitHub to the CHAOSS repository.

Pull Request Checklist

  • Check if your code addition will pass both code linting checks and unit tests.
  • Check if your documentation commits are free from typos.
  • Ensure your commit messages are descriptive. How to Write a Git Commit Message explains how to write good commit messages.
  • Check the commits and commits messages and ensure they are free from typos.

At this point, you are waiting on the CHAOSS repository maintainers. They will comment on your pull requests within three business days (and, typically, one business day).

The CHAOSS repository maintainers will report on open issues and pull requests on the calls and via the mailing list to elicit feedback from the community.