Skip to content

Commit f42f243

Browse files
committed
feat(docs): add the code of conduct
1 parent 0c7e083 commit f42f243

File tree

3 files changed

+92
-7
lines changed

3 files changed

+92
-7
lines changed

CONTRIBUTING.md

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

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Look at this [example](https://moneytrackio.github.io/tezart/?id=examples)
2929

3030
## Feature requests and bugs
3131

32-
If you want to contribute to this project, please fork the project and submit your pull request.
32+
If you want to contribute to this project, read the [code of conduct](CONTRIBUTING.md)
3333

3434
Feature requests and bugs at the [issue tracker](https://github.com/moneytrackio/tezart/issues/new)
3535

docs/README.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ You can :
184184

185185
### Project versionning
186186

187-
We follow the semantic versioning from [semver](semver.org). Given a version number MAJOR.MINOR.PATCH, increment the:
187+
The versioning scheme we use is [SemVer](http://semver.org/). Given a version number MAJOR.MINOR.PATCH, increment the:
188188

189189
- **MAJOR** version when you make incompatible API changes,
190190
- **MINOR** version when you add functionality in a backwards compatible manner, and
@@ -262,9 +262,10 @@ Following is the output usage :
262262

263263
<img src="img/a-current-usage.png?raw=true"></img>
264264

265+
### Pull Request advice
265266

266-
## Feature requests and bugs
267-
268-
If you want to contribute to this project, please [fork](https://github.com/moneytrackio/tezart) the project and submit your pull request.
269-
270-
Submit your feature requests and bugs at the [issue tracker](https://github.com/moneytrackio/tezart/issues/new)
267+
- Ensure to have a correct output for `tezart doctor` in your development environment.
268+
- Update the `docs/README.md` if necessary with details of changes that you've made. This includes new API,
269+
useful command-line option, etc...
270+
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you
271+
do not have permission to do that, you may request the second reviewer to merge it for you.

0 commit comments

Comments
 (0)