forked from cytomining/pycytominer
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding open source guideline documents (cytomining#136)
* add contributing document * add pull request template * add code of conduct file * delete extra space * add note about asking for help * specify pull request procedure and review criteria * add codeowners * add niranj * specify at least pull requesst approval needed
- Loading branch information
Showing
4 changed files
with
262 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# Default owners for everything in the repo. | ||
* @gwaygenomics | ||
* @niranjchandrasekaran | ||
|
||
# Owners of only python files | ||
*.py @gwaygenomics | ||
*.py @niranjchandrasekaran | ||
|
||
# Owners of documentation | ||
docs/* @gwaygenomics | ||
docs/* @niranjchandrasekaran |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
_modified from [EmbeddedArtistry](https://embeddedartistry.com/blog/2017/08/04/a-github-pull-request-template-for-your-projects/)_ | ||
|
||
# Description | ||
|
||
Thank you for your contribution to pycytominer! | ||
Please _succinctly_ summarize your proposed change. | ||
What motivated you to make this change? | ||
|
||
Please also link to any relevant issues that your code is associated with. | ||
|
||
## What is the nature of your change? | ||
|
||
- [ ] Bug fix (fixes an issue). | ||
- [ ] Enhancement (adds functionality). | ||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected). | ||
- [ ] This change requires a documentation update. | ||
|
||
# Checklist | ||
|
||
Please ensure that all boxes are checked before indicating that a pull request is ready for review. | ||
|
||
- [ ] I have read the [CONTRIBUTING.md](CONTRIBUTING.md) guidelines. | ||
- [ ] My code follows the style guidelines of this project. | ||
- [ ] I have performed a self-review of my own code. | ||
- [ ] I have commented my code, particularly in hard-to-understand areas. | ||
- [ ] I have made corresponding changes to the documentation. | ||
- [ ] My changes generate no new warnings. | ||
- [ ] New and existing unit tests pass locally with my changes. | ||
- [ ] I have added tests that prove my fix is effective or that my feature works. | ||
- [ ] I have deleted all non-relevant text in this pull request template. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,97 @@ | ||
# Contributor Covenant _Code of Conduct_ | ||
|
||
## Our pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. | ||
|
||
Our goals are to 1) make meaningful contributions to science, 2) to learn new things, and 3) welcome diverse viewpoints. | ||
We pledge to act and interact with these goals in mind. | ||
|
||
## Our standards | ||
|
||
Examples of behavior that contributes to a positive environment for our community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or advances of any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email address, without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a professional setting | ||
|
||
## Enforcement responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. | ||
|
||
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement by emailing cytodata.info@gmail.com. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the reporter of any incident. | ||
|
||
## Enforcement guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. | ||
A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community impact**: A violation through a single incident or series of actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. | ||
No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. | ||
This includes avoiding interactions in community spaces as well as external channels like social media. | ||
Violating these terms may lead to a temporary or permanent ban. | ||
|
||
### 3. Temporary ban | ||
|
||
**Community impact**: A serious violation of community standards, including sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. | ||
No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent ban | ||
|
||
**Community impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within the community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 2.0, available at | ||
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. | ||
|
||
Community Impact Guidelines were inspired by | ||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at | ||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available | ||
at [https://www.contributor-covenant.org/translations][translations]. | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html | ||
[Mozilla CoC]: https://github.com/mozilla/diversity | ||
[FAQ]: https://www.contributor-covenant.org/faq | ||
[translations]: https://www.contributor-covenant.org/translations |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
# Contributing to pycytominer | ||
|
||
First of all, thank you for contributing to pycytominer! :tada: :100: | ||
|
||
This document contains guidelines on how to most effectively contribute to the pycytominer codebase. | ||
|
||
If you are stuck, please feel free to ask any questions or ask for help. | ||
|
||
## Table Of contents | ||
|
||
[Code of conduct](#code-of-conduct) | ||
|
||
[Quick links](#quick-links) | ||
|
||
[How can I contribute?](#how-can-i-contribute) | ||
* [Bug reporting](#bug-reporting) | ||
* [Suggesting enhancements](#suggesting-enhancements) | ||
* [Your first code contribution](#your-first-code-contribution) | ||
* [Pull requests](#pull-requests) | ||
|
||
[Style guides](#style-guides) | ||
* [Git commit messages](#git-commit-messages) | ||
* [Python style guide](#python-style-guide) | ||
* [Documentation style guide](#documentation-style-guide) | ||
|
||
## Code of conduct | ||
|
||
This project and everyone participating in it is governed by our [code of conduct](CODE_OF_CONDUCT.md). | ||
By participating, you are expected to uphold this code. | ||
Please report unacceptable behavior to cytodata.info@gmail.com. | ||
|
||
## Quick links | ||
|
||
* Documentation: https://pycytominer.readthedocs.io/en/latest/ | ||
* Issue tracker: https://github.com/cytomining/pycytominer/issues | ||
* Code coverage: https://app.codecov.io/gh/cytomining/pycytominer | ||
* Package requirements: https://github.com/cytomining/pycytominer/blob/master/requirements.txt | ||
|
||
## How can I contribute? | ||
|
||
### Bug reporting | ||
|
||
We love hearing about use-cases when our software does not work. | ||
This provides us an opportunity to improve. | ||
However, in order for us to fix a bug, you need to tell us exactly what went wrong. | ||
|
||
When you report a bug, please be prepared to tell us as much pertinent information as possible. | ||
This information includes: | ||
|
||
* The pycytominer version you’re using | ||
* The format of input data | ||
* Copy and paste two pieces of information: 1) your command and 2) the specific error message | ||
* What you’ve tried to overcome the bug | ||
|
||
Please provide this information as an issue in the repository: https://github.com/cytomining/pycytominer/issues | ||
|
||
Please also search the issues (and documentation) for an existing solution. | ||
It’s possible we solved your bug already! | ||
If you find an issue already describing your bug, please add a comment to the issue instead of opening a new one. | ||
|
||
### Suggesting enhancements | ||
|
||
We’re deeply committed to a simple, intuitive user experience, and to support core profiling pipeline data processing. | ||
This commitment requires a good relationship, and open communication, with our users. | ||
|
||
We encourage you to propose enhancements to improve the pycytominer package. | ||
|
||
First, figure out if your proposal is already implemented, by reading the documentation! | ||
Next, check the issues (https://github.com/cytomining/pycytominer/issues) to see if someone else has already proposed the enhancement you have in mind. | ||
If you do find the suggestion, please comment on the existing issue noting that you are also interested in this functionality. | ||
If you do not find the suggestion, please open a new issue and clearly document the specific enhancement and why it would be helpful for your particular use case. | ||
|
||
Please provide your enhancement suggestions as an issue in the repository: | ||
|
||
### Your first code contribution | ||
|
||
Contributing code for the first time can be a daunting task. | ||
However, in our community, we strive to be as welcoming as possible to newcomers, while ensuring rigorous software development practices. | ||
|
||
The first thing to figure out is exactly what you’re going to contribute! | ||
We have specifically tagged [beginner issues](https://github.com/cytomining/pycytominer/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), but we describe all future work as individual [github issues](https://github.com/cytomining/pycytominer/issues). | ||
|
||
If you want to contribute code that we haven’t already outlined, please start a discussion in a new issue before actually writing any code. | ||
A discussion will clarify the new code and reduce merge time. | ||
Plus, it’s possible that your contribution belongs in a different code base, and we do not want to waste your time (or ours)! | ||
|
||
### Pull requests | ||
|
||
After you’ve decided to contribute code and have written it up, now it is time to file a pull request. | ||
We specifically follow a [forked pull request model](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork). | ||
Please create a fork of the pycytominer repository, clone the fork, and then create a new, feature-specific branch. | ||
Once you make the necessary changes on this branch, you should file a pull request to incorporate your changes into the main pycytominer repository. | ||
|
||
The content and description of your pull request are directly related to the speed at which we are able to review, approve, and merge your contribution into pycytominer. | ||
To ensure an efficient review process please perform the following steps: | ||
|
||
1. Follow all instructions in the [pull request template](.github/PULL_REQUEST_TEMPLATE.md) | ||
2. Triple check that your pull request is only adding _one_ specific feature. Small, bite-sized pull requests move so much faster than large pull requests. | ||
3. After submitting your pull request, ensure that your contribution passes all status checks (e.g. passes all tests) | ||
|
||
All pull requests must be reviewed and approved by at least one project maintainer in order to be merged. | ||
We will do our best to review the code addition in a timely fashion. | ||
Ensuring that you follow all steps above will increase our speed and ability to review. | ||
We will check for accuracy, style, code coverage, and scope. | ||
|
||
## Style guides | ||
|
||
Please follow all style guides to the best of your abilities. | ||
|
||
### Git commit messages | ||
|
||
For all commit messages, please use a short phrase that describes the specific change. | ||
For example, “Add feature to check normalization method string” is much preferred to “change code”. | ||
When appropriate, reference issues (via `#` plus number) . | ||
|
||
### Python style guide | ||
|
||
For python code style, we use [black](https://github.com/psf/black). | ||
Please use black before committing any code. | ||
We will not accept code contributions that do not use black. | ||
|
||
### Documentation style guide | ||
|
||
We use the [numpy documentation style guide](https://numpydoc.readthedocs.io/en/latest/format.html). |