Skip to content

Commit 1bc917f

Browse files
committed
added content to contributing.md
1 parent 4193172 commit 1bc917f

File tree

1 file changed

+91
-1
lines changed

1 file changed

+91
-1
lines changed

Contributing.md

+91-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,93 @@
11
## Guide to Contributing to Pypesa Package
2+
# Contributing
23

3-
Loading ... (will be added soon)
4+
When contributing to this repository, please first discuss the change you wish to make via issue,
5+
email, or any other method with the owners of this repository before making a change.
6+
7+
Please note we have a code of conduct, please follow it in all your interactions with the project.
8+
9+
## Pull Request Process
10+
11+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
12+
build.
13+
2. Update the README.md with details of changes to the interface, this includes new environment
14+
variables, exposed ports, useful file locations and container parameters.
15+
3. Increase the version numbers in any examples files and the README.md to the new version that this
16+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
17+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
18+
do not have permission to do that, you may request the second reviewer to merge it for you.
19+
20+
## Code of Conduct
21+
22+
### Our Pledge
23+
24+
In the interest of fostering an open and welcoming environment, we as
25+
contributors and maintainers pledge to making participation in our project and
26+
our community a harassment-free experience for everyone, regardless of age, body
27+
size, disability, ethnicity, gender identity and expression, level of experience,
28+
nationality, personal appearance, race, religion, or sexual identity and
29+
orientation.
30+
31+
### Our Standards
32+
33+
Examples of behavior that contributes to creating a positive environment
34+
include:
35+
36+
* Using welcoming and inclusive language
37+
* Being respectful of differing viewpoints and experiences
38+
* Gracefully accepting constructive criticism
39+
* Focusing on what is best for the community
40+
* Showing empathy towards other community members
41+
42+
Examples of unacceptable behavior by participants include:
43+
44+
* The use of sexualized language or imagery and unwelcome sexual attention or
45+
advances
46+
* Trolling, insulting/derogatory comments, and personal or political attacks
47+
* Public or private harassment
48+
* Publishing others' private information, such as a physical or electronic
49+
address, without explicit permission
50+
* Other conduct which could reasonably be considered inappropriate in a
51+
professional setting
52+
53+
### Our Responsibilities
54+
55+
Project maintainers are responsible for clarifying the standards of acceptable
56+
behavior and are expected to take appropriate and fair corrective action in
57+
response to any instances of unacceptable behavior.
58+
59+
Project maintainers have the right and responsibility to remove, edit, or
60+
reject comments, commits, code, wiki edits, issues, and other contributions
61+
that are not aligned to this Code of Conduct, or to ban temporarily or
62+
permanently any contributor for other behaviors that they deem inappropriate,
63+
threatening, offensive, or harmful.
64+
65+
### Scope
66+
67+
This Code of Conduct applies both within project spaces and in public spaces
68+
when an individual is representing the project or its community. Examples of
69+
representing a project or community include using an official project e-mail
70+
address, posting via an official social media account, or acting as an appointed
71+
representative at an online or offline event. Representation of a project may be
72+
further defined and clarified by project maintainers.
73+
74+
### Enforcement
75+
76+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
77+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
78+
complaints will be reviewed and investigated and will result in a response that
79+
is deemed necessary and appropriate to the circumstances. The project team is
80+
obligated to maintain confidentiality with regard to the reporter of an incident.
81+
Further details of specific enforcement policies may be posted separately.
82+
83+
Project maintainers who do not follow or enforce the Code of Conduct in good
84+
faith may face temporary or permanent repercussions as determined by other
85+
members of the project's leadership.
86+
87+
### Attribution
88+
89+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
90+
available at [http://contributor-covenant.org/version/1/4][version]
91+
92+
[homepage]: http://contributor-covenant.org
93+
[version]: http://contributor-covenant.org/version/1/4/

0 commit comments

Comments
 (0)