Skip to content

Commit c46c778

Browse files
Mec-iSMec-iS
committed
Add Github templates
1 parent bd87750 commit c46c778

File tree

4 files changed

+92
-0
lines changed

4 files changed

+92
-0
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Code of Conduct
2+
3+
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4+
5+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
6+
7+
Examples of unacceptable behavior by participants include:
8+
9+
* The use of sexualized language or imagery
10+
* Personal attacks
11+
* Trolling or insulting/derogatory comments
12+
* Public or private harassment
13+
* Publishing other's private information, such as physical or electronic addresses, without explicit permission
14+
* Other unethical or unprofessional conduct.
15+
16+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
17+
18+
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
19+
20+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
21+
22+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

‎.github/CONTRIBUTING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
### Contribution Best Practices
2+
3+
* Read this [how-to about Github workflow here](https://guides.github.com/introduction/flow/) if you are not familiar with.
4+
5+
* Read all the texts related to [contributing for an OS community](https://github.com/HTTP-APIs/hydrus/tree/master/.github).
6+
7+
* Read this [how-to about writing a PR](https://github.com/blog/1943-how-to-write-the-perfect-pull-request) and this [other how-to about writing a issue](https://wiredcraft.com/blog/how-we-write-our-github-issues/)
8+
9+
* **first ask in chat**: if you find a problem, first ask for [help in the chat](https://gitter.im/HTTP-APIs/Lobby), then consider opening a issue.
10+
11+
* **read history**: before opening a PR be sure that all the tests pass successfully. If any is failing for non-related reasons, annotate the test failure in the PR comment.
12+
13+
* **PRs on develop**: any change should be PRed first in `develop`, `master` can only receive merge from develop.
14+
15+
* **testing**: everything should work and be tested for Python 3.5.2 and above.
16+
17+
* **free PR**: no permission is needed to work on the code. Fork `master`, submit a PR and ask for reviewing. PR is the natural place for code comparison and corrections. If many contributors have something ready in a PR, we can consider opening a branch in which different people working on the same part of the application can collaborate.
18+
19+
* **pylint**: code in PRs should be accurately compliant with [PEP-8](https://www.python.org/dev/peps/pep-0008/), checking code with `pylint` is fine.
20+
21+
* **mypy**: every module is and should in future provide type annotations using `mypy`.

‎.github/ISSUE_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
### I'm submitting a
2+
- [ ] bug report.
3+
- [ ] feature request.
4+
5+
### Current Behaviour:
6+
<!-- Describe about the bug -->
7+
8+
### Expected Behaviour:
9+
<!-- Describe what will happen if bug is removed -->
10+
11+
### Steps to reproduce:
12+
<!-- If you can then please provide the steps to reproduce the bug -->
13+
14+
### Do you want to work on this issue?
15+
<!-- yes/no -->

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- Please create/claim an issue before sending a PR -->
2+
<!-- Add issue number (Eg: fixes #123) -->
3+
4+
Fixes #
5+
6+
### Checklist
7+
- [ ] My branch is up-to-date with upstream/develop branch.
8+
- [ ] Everything works and tested for Python 3.5.2 and above.
9+
10+
### Description
11+
<!-- Describe about what this PR does, previous state and new state of the output -->
12+
13+
### Change logs
14+
15+
<!-- #### Added -->
16+
<!-- Edit these points below to describe the new features added with this PR -->
17+
<!-- - Feature 1 -->
18+
<!-- - Feature 2 -->
19+
20+
21+
<!-- #### Changed -->
22+
<!-- Edit these points below to describe the changes made in existing functionality with this PR -->
23+
<!-- - Change 1 -->
24+
<!-- - Change 1 -->
25+
26+
27+
<!-- #### Fixed -->
28+
<!-- Edit these points below to describe the bug fixes made with this PR -->
29+
<!-- - Bug 1 -->
30+
31+
32+
<!-- #### Removed -->
33+
<!-- Edit these points below to describe the removed features with this PR -->
34+
<!-- - Deprecated feature 1 -->

0 commit comments

Comments
 (0)