Skip to content

Commit 5ce31b4

Browse files
phillipaherezaDavidLemayian
phillipahereza
authored and
DavidLemayian
committed
added git templates (#20)
1 parent 493c1ee commit 5ce31b4

File tree

3 files changed

+157
-0
lines changed

3 files changed

+157
-0
lines changed

‎.github/ISSUE_TEMPLATE.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Description
2+
A clear and concise description of what the issue is about.
3+
4+
## Screenshots
5+
6+
7+
## Files
8+
A list of relevant files for this issue. This will help people navigate the project and offer some clues of where to start.
9+
10+
## To Reproduce
11+
If this issue is describing a bug, include some steps to reproduce the behavior.
12+
13+
## Tasks
14+
Include specific tasks in the order they need to be done in. Include links to specific lines of code where the task should happen at.
15+
- [ ] Task 1
16+
- [ ] Task 2
17+
- [ ] Task 3
18+

‎.github/PULL_REQUEST_TEMPLATE.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
## Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
17+
## Screenshots
18+
19+
20+
## Checklist:
21+
22+
- [ ] My code follows the style guidelines of this project
23+
- [ ] I have performed a self-review of my own code
24+
- [ ] I have commented my code, particularly in hard-to-understand areas
25+
- [ ] I have made corresponding changes to the documentation

‎CONTRIBUTING.md

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Introduction
2+
3+
You are here to help on [openAFRICA](https://africaopendata.org) deployment? Awesome, feel welcome and read the following
4+
sections in order to know what and how to work on something. If you get stuck
5+
at any point you can create a ticket on
6+
[GitHub](https://github.com/CodeForAfricaLabs/openAFRICA/issues/).
7+
8+
All members of our community are expected to follow our
9+
[Code of Conduct](https://github.com/CodeForAfrica/CodeOfConduct). Please make
10+
sure you are welcoming and friendly in all of our spaces.
11+
12+
Following these guidelines helps to communicate that you respect the time of
13+
the developers managing and developing this open source project. In return,
14+
they should reciprocate that respect in addressing your issue, assessing
15+
changes, and helping you finalize your pull requests.
16+
17+
## Types of Contributions
18+
19+
You can contribute in many ways. For example, you might:
20+
* Add documentation and "how-to" articles in the [README](README.md) or the wiki
21+
* Suggest Enhancements
22+
* Fix issues
23+
* Submit Bug reports
24+
25+
#### Bug Reports
26+
*If you find a security vulnerability, **DO NOT** open an issue. Email
27+
[[email protected]](mailto:[email protected]) instead.*
28+
29+
If you're reporting a bug, please include:
30+
* Your operating system name and version
31+
* Any details about your local setup that might be helpful in troubleshooting.
32+
* If you can, provide detailed steps to reproduce the bug.
33+
* If you don't have steps to reproduce the bug, just note your observations in
34+
as much detail as you can. Questions to start a discussion about the issue
35+
are welcome.
36+
37+
To ease the process of reporting bugs and issues, consider using our
38+
[issue template](https://github.com/CodeForAfricaLabs/openAFRICA/blob/master/.github/ISSUE_TEMPLATE.md)
39+
and don't forget to add an appropriate
40+
[label](https://help.github.com/articles/creating-a-label/) to the issue.
41+
42+
#### Writing Documentation
43+
Did you find a typo? Do you think that something should be clarified? Go ahead
44+
and suggest a documentation patch. The openAFRICA deployment could always use more documentation,
45+
whether as part of the official docs, in docstrings, or even on the web in blog
46+
posts, wiki, articles, and such.
47+
48+
#### Fixing Issues
49+
Look through the GitHub issues for bugs. Anything tagged with "bug" is open to
50+
whoever wants to implement it.
51+
52+
#### Suggesting Enhancements
53+
54+
Before creating enhancement suggestions, please check the issues list as you
55+
might find out that you don't need to create one. When you are creating an
56+
enhancement suggestion fill out the
57+
[issue template](https://github.com/CodeForAfricaLabs/openAFRICA/blob/master/.github/ISSUE_TEMPLATE.md)
58+
and [label](https://help.github.com/articles/creating-a-label/) the issue as a
59+
new feature.
60+
61+
## Your first contribution
62+
63+
Unsure where to begin contributing to openAFRICA? You can start by looking through
64+
these `beginner` and `help-wanted` issues:
65+
66+
* `Beginner issues` - issues which should only require a few lines of code, and a
67+
test or two.
68+
* `Help wanted issues` - issues which should be a bit more involved than beginner
69+
issues.
70+
71+
Once your changes and tests are ready to submit for review:
72+
73+
1. Test your changes
74+
75+
Run the tests if you have any and at the bare minimum, test your changes
76+
manually.
77+
78+
2. Rebase your changes
79+
80+
Update your local repository with the most recent code from the main openAFRICA
81+
repository, and rebase your branch on top of the latest develop branch.
82+
83+
3. Submit a pull request
84+
85+
Push your local changes to your forked copy of the repository and submit a
86+
pull request. In the pull request, choose a title which sums up the changes
87+
that you have made, and in the body provide more details about what your
88+
changes do. Also mention the number of the issue where discussion has taken
89+
place. Preferably use our
90+
[PR template](https://github.com/CodeForAfricaLabs/openAFRICA/blob/master/.github/PULL_REQUEST_TEMPLATE.md).
91+
92+
Then sit back and wait. There will probably be discussion about the pull
93+
request and, if any changes are needed, we would love to work with you to
94+
get your pull request merged into openAFRICA.
95+
96+
## Code Style
97+
98+
Please adhere to the [PEP8](https://www.python.org/dev/peps/pep-0008/) Coding
99+
conventions for the Python language. This style guide evolves over time as
100+
additional conventions are identified and past conventions are rendered obsolete
101+
by changes in the language itself. Ensure to keep updated.
102+
103+
## Ground Rules
104+
The goal is to maintain a diverse community that's pleasant for everyone.
105+
That's why we would greatly appreciate it if everyone contributing to and
106+
interacting with the community also followed this
107+
[Code of Conduct](https://github.com/CodeForAfrica/CodeOfConduct).
108+
The [Code of Conduct](https://github.com/CodeForAfrica/CodeOfConduct) covers our
109+
behavior as members of the community, in any forum, mailing list, wiki, website,
110+
Internet relay chat (IRC), public meeting or private correspondence.
111+
112+
113+
114+
Please see [contribution-guide.org](http://www.contribution-guide.org) for details on what we expect from contributors. Thanks!

0 commit comments

Comments
 (0)