Skip to content

Commit df91759

Browse files
jonrkarrjonrkarr
committed
adding guide to contribute and code of conduct
1 parent 5bbfb53 commit df91759

File tree

2 files changed

+193
-0
lines changed

2 files changed

+193
-0
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[[email protected]](mailto:[email protected]).
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html).
118+
119+
The Community Impact Guidelines were inspired by [Mozilla's Code of Conduct Enforcement ladder](https://github.com/mozilla/diversity).
120+
121+
Answers to common questions about this code of conduct are available at
122+
https://www.contributor-covenant.org/faq. Translations of this code of conduct are available at
123+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Contributing to `BioSimulators-COBRApy`
2+
3+
We enthusiastically welcome contributions to BioSimulators-COBRApy!
4+
5+
## Coordinating contributions
6+
7+
Before getting started, please contact the lead developers at [[email protected]](mailto:[email protected]) to coordinate your planned contributions with other ongoing efforts. Please also use GitHub issues to announce your plans to the community so that other developers can provide input into your plans and coordinate their own work.
8+
9+
## Repository organization
10+
11+
The repository follows standard Python conventions:
12+
13+
* `README.md`: Overview of the repository
14+
* `biosimulators_cobrapy/`: Python code for a BioSimulators-compliant command-line interface to COBRApy
15+
* `tests/`: unit tests for the command-line interface
16+
* `setup.py`: installation script for the command-line interface
17+
* `setup.cfg`: configuration for the installation of the command-line interface
18+
* `requirements.txt`: dependencies for the command-line interface
19+
* `requirements.optional.txt`: optional dependencies for the command-line interface
20+
* `MANIFEST.in`: a list of files to include in the package for the command-line interface
21+
* `LICENSE`: License
22+
* `CONTRIBUTING.md`: Guide to contributing to BioSimulators-COBRApy (this document)
23+
* `CODE_OF_CONDUCT.md`: Code of conduct for developers of BioSimulators-COBRApy
24+
25+
## Coding convention
26+
27+
BioSimulators-COBRApy follows standard Python style conventions:
28+
29+
* Class names: `UpperCamelCase`
30+
* Function names: `lower_snake_case`
31+
* Variable names: `lower_snake_case`
32+
33+
## Testing and continuous integration
34+
35+
We strive to have complete test coverage for BioSimulators-COBRApy.
36+
37+
The unit tests for BioSimulators-COBRApy are located in the `tests` directory. The tests can be executed by running the following command:
38+
```
39+
pip install pytest
40+
python -m pytest tests
41+
```
42+
43+
The tests are also automatically evaluated upon each push to GitHub.
44+
45+
The coverage of the tests can be evaluated by running the following commands and then opening `/path/to/biosimulators_cobrapy/htmlcov/index.html` with your browser.
46+
```
47+
pip install pytest pytest-cov coverage
48+
python -m pytest tests --cov biosimulators_cobrapy
49+
coverage html
50+
```
51+
52+
## Documentation convention
53+
54+
BioSimulators-COBRApy is documented using [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html) and the [napoleon Sphinx plugin](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html).
55+
56+
## Submitting changes
57+
58+
Please use GitHub pull requests to submit changes. Each request should include a brief description of the new and/or modified features.
59+
60+
## Releasing and deploying new versions
61+
62+
Contact the [BioSimulators Team](mailto:[email protected]) to request release and deployment of new changes.
63+
64+
## Reporting issues
65+
66+
Please use [GitHub issues](https://github.com/biosimulators/Biosimulators_COBRApy/issues) to report any issues to the development community.
67+
68+
## Getting help
69+
70+
Please use [GitHub issues](https://github.com/biosimulators/Biosimulators_COBRApy/issues) to post questions or contact the lead developers at [[email protected]](mailto:[email protected]).

0 commit comments

Comments
 (0)