Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 3.67 KB

CONTRIBUTING.md

File metadata and controls

33 lines (17 loc) · 3.67 KB

Contribution guidelines for Project Cognoma repositories

Project Philosophy

Project Cognoma is an open source community-based project. Beyond our immediate scientific aspirations, we want to engage as many individuals as possible in doing cool work. Project Cognoma is a place to learn and grow as a community. So don't be shy. We want your contribution. Given the nature of open source development, not all contributions can be included … but all will be appreciated and help the project bloom.

Issues

We use GitHub Issues for a wide range of tasks including bug reports, feature requests, planning, and general forum. Don't worry about whether your use of GitHub Issues is legitimate, but do try to pick the best repository to file your issue under.

Pull Requests

Project Cognoma operates on a pull request model. For the cognoma/cognoma repository, all changes should be submitted via pull request. Component projects (e.g. cognoma/django-cognoma) may define their own pull request models to facilitate emergency fixes if required. We also encourage you to comment on and review open pull requests.

To keep the commit history clean, we may ask you to rebase your pull request or squash certain commits. If you don't know what this means, we'll help you through the process.

Peer Review

All pull requests undergo peer review in which project participants review the changes. Reviewers may suggest modifications or even note their disapproval. Reviewers can note their approval by commenting along the lines of ":+1:", "looks good to me", or "approved". As a reviewer, it's helpful to note the type of review you performed: did you test the code, look it over, or are you just supporting the concept?

Before a repository maintainer merges a pull request, there must be at least one affirmative review. If there is any unaddressed criticism or disapproval, a repository maintainer will determine how to proceed and may wait for additional feedback.

Happy contributing!


Note: You do not have to read the following information to contribute.

Commit Access

Currently, members of the cognoma GitHub organization have commit access on all cognoma repositories. However, our goal is to transition to sustainable project development without the direct need for organization involvement. Therefore, organization members will grant (and revoke) commit access on a per repository level. For example, a Django developer working on cognoma/django-cognoma will receive commit access to cognoma/django-cognoma but not necessarily cognoma/cognoma. Commit access will be extended based on a history of positive involvement in the project.

The primary purpose of commit access is for merging pull requests. The committer should use their best judgment on how how much review is necessary for a given pull request. For some pull requests, a single individual with commit access may be able to fully review a pull request. Commit access may also be used for small or urgent changes as specified by the repository-specific CONTRIBUTING.md. If you think Project Cognoma would benefit from granting you commit access, please contact an organization member. However, please don't request commit access until you've accumulated a history of involvement in the project.