Skip to content

Commit 89fdb92

Browse files
committed
Add contributing guidelines
1 parent 1c81301 commit 89fdb92

File tree

2 files changed

+112
-0
lines changed

2 files changed

+112
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at <imas-administration@iter.org>. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+

CONTRIBUTING.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Contributing guidelines
2+
3+
We welcome any kind of contribution to `IMAS-Java`,
4+
from a simple comment, a question or even a full fledged pull
5+
request.
6+
Please first make sure you read and follow the
7+
[Code of Conduct](CODE_OF_CONDUCT.md).
8+
9+
## You think you found a bug in the code, or have a question in its use
10+
1. use the [issue search](https://github.com/iterorganization/IMAS-Java/issues)
11+
to check if someone already created a similar issue;
12+
2. if not, make a **new issue** to describe your problem or question.
13+
In the case of a bug suspiscion, please try to give all the relevant
14+
information to allow reproducing the error or identifying
15+
its root cause (version of the IMAS-Java, OS and relevant
16+
dependencies, snippet of code);
17+
3. apply relevant labels to the issue.
18+
19+
## You want to make or ask some change to the code
20+
1. use the [issue search](https://github.com/iterorganization/IMAS-Java/issues)
21+
to check if someone already proposed a similar idea/change;
22+
2. if not, create a **new issue** to describe what change you would like to see
23+
implemented and specify it if you intend to work on it yourself or if some help
24+
will be needed;
25+
3. wait until some kind of consensus is reached about your idea being relevant,
26+
at which time the issue will be assigned (to you or someone else who can work on
27+
this topic);
28+
4. if you do the development yourself, fork the repository to your own Github
29+
profile and create your own feature branch off of the latest develop commit.
30+
Make sure to regularly sync your branch with the latest commits from `develop`
31+
(find instructions
32+
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork));
33+
5. when your development is ready, create a pull request (find instructions
34+
[here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)).
35+
36+
37+
While we will try to answer questions quickly and to address issues in a timely
38+
manner, it can may sometimes take longer than expected. A friendly ping in the
39+
discussion or the issue thread can help draw attention if you find that it was
40+
stalled.

0 commit comments

Comments
 (0)