Skip to content
This repository was archived by the owner on Dec 26, 2022. It is now read-only.

Commit 60cad21

Browse files
authored
Merge pull request #450 from HowJMay/contribute
doc(CONTRIBUTING): Add Contributing notice
2 parents 0a2e2af + a426b94 commit 60cad21

File tree

1 file changed

+96
-0
lines changed

1 file changed

+96
-0
lines changed

CONTRIBUTING.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Contributing to Tangle-accelerator
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11+
build.
12+
2. Create a new branch for fixing or developing the changes.
13+
3. Run test with `bazel test //tests/...`, after finishing the changes.
14+
4. Update the README.md with details of changes to the interface, which includes new environment
15+
variables, exposed ports, useful file locations and container parameters.
16+
5. Run `hooks/formatter` before committing the changes.
17+
6. Rebase to the latest `develop` branch.
18+
19+
## Git Commit Message Guidelines
20+
Read this [blog article](https://chris.beams.io/posts/git-commit/) and [this article](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) and follow the instructions in these articles.
21+
The subject line of git commit message should follow this pattern
22+
`<type>[optional scope]: <description>`
23+
The `type` includes the following 5 words depending on the content of the commit.
24+
25+
* feat
26+
* fix
27+
* refactor
28+
* test
29+
* doc
30+
31+
## Code of Conduct
32+
33+
### Our Pledge
34+
35+
In the interest of fostering an open and welcoming environment, we as
36+
contributors and maintainers pledge to make participation in our project and
37+
our community a harassment-free experience for everyone, regardless of age, body
38+
size, disability, ethnicity, gender identity and expression, level of experience,
39+
nationality, personal appearance, race, religion, or sexual identity and
40+
orientation.
41+
42+
### Our Standards
43+
44+
Examples of behavior that contributes to creating a positive environment
45+
include:
46+
47+
* Using welcoming and inclusive language
48+
* Being respectful of differing viewpoints and experiences
49+
* Gracefully accepting constructive criticism
50+
* Focusing on what is best for the community
51+
* Showing empathy towards other community members
52+
53+
Examples of unacceptable behavior by participants include:
54+
55+
* The use of sexualized language or imagery and unwelcome sexual attention or
56+
advances
57+
* Trolling, insulting/derogatory comments, and personal or political attacks
58+
* Public or private harassment
59+
* Publishing others' private information, such as a physical or electronic
60+
address, without explicit permission
61+
* Other conduct which could reasonably be considered inappropriate in a
62+
professional setting
63+
64+
### Our Responsibilities
65+
66+
Project maintainers are responsible for clarifying the standards of acceptable
67+
behavior and are expected to take appropriate and fair corrective action in
68+
response to any instances of unacceptable behavior.
69+
70+
Project maintainers have the right and responsibility to remove, edit, or
71+
reject comments, commits, code, wiki edits, issues, and other contributions
72+
that are not aligned to this Code of Conduct, or to ban temporarily or
73+
permanently any contributor for other behaviors that they deem inappropriate,
74+
threatening, offensive, or harmful.
75+
76+
### Scope
77+
78+
This Code of Conduct applies both within project spaces and in public spaces
79+
when an individual is representing the project or its community. Examples of
80+
representing a project or community include using an official project e-mail
81+
address, posting via an official social media account or acting as an appointed
82+
representative at an online or offline event. Representation of a project may be
83+
further defined and clarified by project maintainers.
84+
85+
### Enforcement
86+
87+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
88+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
89+
complaints will be reviewed and investigated and will result in a response that
90+
is deemed necessary and appropriate to the circumstances. The project team is
91+
obligated to maintain confidentiality with regard to the reporter of an incident.
92+
Further details of specific enforcement policies may be posted separately.
93+
94+
Project maintainers who do not follow or enforce the Code of Conduct in good
95+
faith may face temporary or permanent repercussions as determined by other
96+
members of the project's leadership.

0 commit comments

Comments
 (0)