Skip to content

Commit 638f14a

Browse files
authored
Merge pull request ddbourgin#10 from WuZhuoran/docs-add-community-docs
Add community profile with code of conduct and issue + pull request template
2 parents e592f8f + 0288b55 commit 638f14a

File tree

4 files changed

+143
-0
lines changed

4 files changed

+143
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Bug/Performance Issue
3+
about: Use this template for reporting a bug or a performance issue.
4+
labels: bugfix
5+
---
6+
7+
**System information**
8+
- Have I written custom code (as opposed to using a stock example script provided in TensorFlow):
9+
- OS Platform and Distribution (e.g., Linux Ubuntu 16.04):
10+
- Python version:
11+
12+
**Describe the current behavior**
13+
14+
**Describe the expected behavior**
15+
16+
**Code to reproduce the issue**
17+
Provide a reproducible test case that is the bare minimum necessary to generate the problem.
18+
19+
**Other info / logs**
20+
Include any logs or source code that would be helpful to diagnose the problem.
21+
If including tracebacks, please include the full traceback. Large logs and files should be attached.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: a) Bug fix
3+
about: Select this if you're fixing a bug in Numpy-ml.
4+
labels: bugfix
5+
---
6+
7+
<!--
8+
Please make sure you've read and understood our contributing guidelines;
9+
https://github.com/ddbourgin/numpy-ml/blob/master/contributing.md
10+
-->
11+
12+
**- What bug I fixed**
13+
14+
This pull request fixes #issue_number_here .
15+
16+
**- How I fixed it**
17+
18+
**- How you can verify it**
19+
<!-- You need a good justification for not including tests for the bug you fixed. -->
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: b) New feature
3+
about: Select this if you're adding a new feature to Numpy-ml.
4+
labels: feature
5+
---
6+
7+
<!--
8+
Please make sure you've read and understood our contributing guidelines;
9+
https://github.com/ddbourgin/numpy-ml/blob/master/contributing.md
10+
-->
11+
12+
This pull request closes #issue_number_here .
13+
14+
**- What I did**
15+
16+
**- How I did it**
17+
18+
**- How to verify it**
19+
<!--
20+
You need a good justification for not
21+
including tests for the new feature you added.
22+
-->
23+
24+
25+
- [ ] I updated the docs.
26+
27+
This pull request adds a new feature to Numpy-ml. Ask @ddbourgin to take a look.

CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Numpy-ML 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 within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be 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

0 commit comments

Comments
 (0)