Skip to content

Latest commit

 

History

History
65 lines (36 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

65 lines (36 loc) · 2.79 KB

How 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.

Where can I contribute?

Anyone can contribute to CHAOSS on any of our communication channels. See https://chaoss.community/participate/.

Which channel should I use?

Conversations and high-level contributions (email, call, f2f)

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.

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 git@github.com:<your-username>/<repository>.git

Create a feature branch in your local repository:

git checkout -b <branch>

Make your change and commit the change:

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

Push to your fork on GitHub:

git push origin <branch>

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

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 mail list to elicit feedback from the community.

Who is a CHAOSS repository maintainer?

The README.md of the repository contains a list of who is maintainer. Each CHAOSS repositry brings together different people and they document in the repository specific CONTRIBUTING.md how somone becomes a maintainer on their repository.

What about releases?

CHAOSS repository maintainers tag commits on the master branch as releases (snapshots). Each CHAOSS repository has its own release cadence. Between releases, the master branch is under development.