From 937ef648ce086907d2c010d8135445b8ab8e1cec Mon Sep 17 00:00:00 2001 From: WuZhuoran Date: Mon, 8 Jul 2019 11:52:05 -0700 Subject: [PATCH 1/2] docs: add CODE OF CONDUCT --- CODE_OF_CONDUCT.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..6d0e26f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Numpy-ML Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +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, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies within all project spaces, and it also applies when +an individual is representing the project or its community in public spaces. +Examples of representing a project or community include using an official +project e-mail address, posting via an official social media account, or acting +as an appointed representative at an online or offline event. Representation of +a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [ddbourgin@gmail.com]. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq From 0288b5556f6ac2234a79e75312cc36a1aae1478f Mon Sep 17 00:00:00 2001 From: WuZhuoran Date: Mon, 8 Jul 2019 12:13:19 -0700 Subject: [PATCH 2/2] docs: add issue and pull request template --- .../a--bug-performance-issue.md | 21 +++++++++++++++ .github/PULL_REQUEST_TEMPLATE/a--bug-fix.md | 19 +++++++++++++ .../PULL_REQUEST_TEMPLATE/b--new-feature.md | 27 +++++++++++++++++++ 3 files changed, 67 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/a--bug-performance-issue.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/a--bug-fix.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/b--new-feature.md diff --git a/.github/ISSUE_TEMPLATE/a--bug-performance-issue.md b/.github/ISSUE_TEMPLATE/a--bug-performance-issue.md new file mode 100644 index 0000000..495a6cf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/a--bug-performance-issue.md @@ -0,0 +1,21 @@ +--- +name: Bug/Performance Issue +about: Use this template for reporting a bug or a performance issue. +labels: bugfix +--- + +**System information** +- Have I written custom code (as opposed to using a stock example script provided in TensorFlow): +- OS Platform and Distribution (e.g., Linux Ubuntu 16.04): +- Python version: + +**Describe the current behavior** + +**Describe the expected behavior** + +**Code to reproduce the issue** +Provide a reproducible test case that is the bare minimum necessary to generate the problem. + +**Other info / logs** +Include any logs or source code that would be helpful to diagnose the problem. +If including tracebacks, please include the full traceback. Large logs and files should be attached. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/a--bug-fix.md b/.github/PULL_REQUEST_TEMPLATE/a--bug-fix.md new file mode 100644 index 0000000..ef8f600 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/a--bug-fix.md @@ -0,0 +1,19 @@ +--- +name: a) Bug fix +about: Select this if you're fixing a bug in Numpy-ml. +labels: bugfix +--- + + + +**- What bug I fixed** + +This pull request fixes #issue_number_here . + +**- How I fixed it** + +**- How you can verify it** + \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE/b--new-feature.md b/.github/PULL_REQUEST_TEMPLATE/b--new-feature.md new file mode 100644 index 0000000..d38a536 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/b--new-feature.md @@ -0,0 +1,27 @@ +--- +name: b) New feature +about: Select this if you're adding a new feature to Numpy-ml. +labels: feature +--- + + + +This pull request closes #issue_number_here . + +**- What I did** + +**- How I did it** + +**- How to verify it** + + + +- [ ] I updated the docs. + +This pull request adds a new feature to Numpy-ml. Ask @ddbourgin to take a look. \ No newline at end of file