Skip to content

Commit 0954c83

Browse files
committed
docs: add community guides
1 parent dd4346d commit 0954c83

File tree

4 files changed

+230
-0
lines changed

4 files changed

+230
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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 making 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 both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
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 [email protected]. 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+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
# Contributing
2+
3+
I'm really glad you're reading this, because we need volunteer developers to help this project come to fruition.
4+
5+
EWEA is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into ewea-web itself.
6+
7+
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
8+
9+
These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
10+
11+
## Code of Conduct
12+
13+
EWEA project has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://github.com/CodeTanzania/ewea-api-client/blob/develop/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
14+
15+
## Open Development
16+
17+
All work on EWEA happens directly on [GitHub](https://github.com/CodeTanzania/ewea-web). Both core team members and external contributors send pull requests which go through the same review process.
18+
19+
## Branch Organization
20+
21+
We will do our best to keep the [`master` branch](https://github.com/CodeTanzania/ewea-api-client/tree/master) in good shape, with tests passing at all times.
22+
23+
If you send a pull request, please do it against the [`develop` branch](https://github.com/CodeTanzania/ewea-api-client/tree/develop).
24+
25+
## Semantic Versioning
26+
27+
EWEA follows [semantic versioning](http://semver.org/). We release patch versions for bugfixes, minor versions for new features, and major versions for any breaking changes.
28+
29+
## Where to Find Known Issues
30+
31+
We are using [GitHub Issues](https://github.com/CodeTanzania/ewea-api-client/issues) for all issues. Before filing a new task, try to make sure your problem doesn't already exist.
32+
33+
## Proposing a Change
34+
35+
If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend [filing an issue](https://github.com/CodeTanzania/ewea-api-client/issues/new). This lets us reach an agreement on your proposal before you put significant effort into it.
36+
37+
If you're only fixing a bug, it's fine to submit a pull request right away but we still recommend to file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.
38+
39+
## Your First Pull Request
40+
41+
Working on your first Pull Request? You can learn how from this free video series:
42+
43+
**[How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)**
44+
45+
If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.
46+
47+
If somebody claims an issue but doesn't follow up for more than two weeks, it's fine to take it over but you should still leave a comment.
48+
49+
## Sending a Pull Request
50+
51+
The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation. We'll do our best to provide updates and feedback throughout the process.
52+
53+
## Style Guide
54+
55+
Look at [Airbnb's Style Guide](https://github.com/airbnb/javascript) will guide you in the right direction.
56+
57+
## Git Commit Guidelines
58+
59+
We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. But also, we use the git commit messages to **generate change log**.
60+
61+
The commit message formatting can be added using a typical git workflow or through the use of a CLI wizard ([Commitizen](https://github.com/commitizen/cz-cli)). To use the wizard, run `npm run cmt` in your terminal after staging your changes in git.
62+
63+
### Commit Message Format
64+
65+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
66+
67+
```
68+
<type>(<scope>): <subject>
69+
<BLANK LINE>
70+
<body>
71+
<BLANK LINE>
72+
<footer>
73+
```
74+
75+
The **header** is mandatory and the **scope** of the header is optional.
76+
77+
Any line of the commit message cannot be longer 100 characters!. This allows the message to be easier to read on GitHub as well as in various git tools.
78+
79+
### Revert
80+
81+
If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted. A commit with this format is automatically created by the [`git revert`](https://git-scm.com/docs/git-revert) command.
82+
83+
### Type
84+
85+
Must be one of the following:
86+
87+
- **feat**: A new feature
88+
- **fix**: A bug fix
89+
- **docs**: Documentation only changes
90+
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
91+
- **refactor**: A code change that neither fixes a bug nor adds a feature
92+
- **perf**: A code change that improves performance
93+
- **test**: Adding missing or correcting existing tests
94+
- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation
95+
96+
### Scope
97+
98+
The scope could be anything specifying place of the commit change. You can use `*` when the change affects more than a single scope.
99+
100+
### Subject
101+
102+
The subject contains succinct description of the change:
103+
104+
- use the imperative, present tense: "change" not "changed" nor "changes"
105+
- don't capitalize first letter
106+
- no dot (.) at the end
107+
108+
### Body
109+
110+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
111+
112+
### Footer
113+
114+
The footer should contain any information about **Breaking Changes** and is also the place to [reference GitHub issues that this commit closes](https://help.github.com/articles/closing-issues-using-keywords/).
115+
116+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. A detailed explanation can be found in this [document](#commit-message-format).
117+
118+
## License
119+
120+
By contributing to EWEA, you agree that your contributions will be licensed under its MIT license.
121+
122+
## Developer's Certificate of Origin 1.1
123+
124+
By making a contribution to this project, I certify that:
125+
126+
- (a) The contribution was created in whole or in part by me and I
127+
have the right to submit it under the open source license
128+
indicated in the file; or
129+
130+
- (b) The contribution is based upon previous work that, to the best
131+
of my knowledge, is covered under an appropriate open source
132+
license and I have the right under that license to submit that
133+
work with modifications, whether created in whole or in part
134+
by me, under the same open source license (unless I am
135+
permitted to submit under a different license), as indicated
136+
in the file; or
137+
138+
- (c) The contribution was provided directly to me by some other
139+
person who certified (a), (b) or (c) and I have not modified
140+
it.
141+
142+
- (d) I understand and agree that this project and the contribution
143+
are public and that a record of the contribution (including all
144+
personal information I submit with it, including my sign-off) is
145+
maintained indefinitely and may be redistributed consistent with
146+
this project or the open source license(s) involved.

GOVERNANCE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Governance
2+
3+
The EWEA project is governed by its Collaborators, including a Technical
4+
Steering Committee (TSC) which is responsible for high-level guidance of the
5+
project.

SECURITY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Security
2+
3+
If you find a security vulnerability in EWEA, file a [new issue](https://github.com/CodeTanzania/ewea-api-client/issues).

0 commit comments

Comments
 (0)