diff options
| author | 2020-06-10 02:18:37 +0000 | |
|---|---|---|
| committer | 2020-06-10 02:21:48 +0000 | |
| commit | a783f397627532a8491676670ca914f1c3299227 (patch) | |
| tree | 98a7a0ba9ceafed8cbe2009622af3e7517d0f104 | |
| parent | c3e594f869b1d79cec627d9cff26391795f614e7 (diff) | |
contributing: Init
| -rw-r--r-- | CODE_OF_CONDUCT.md | 76 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 52 |
2 files changed, 128 insertions, 0 deletions
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..c7557ef --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make 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 leader at [rgoswami@ieee.org](mailto:rgoswami@ieee.org). 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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e1d6fc5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# Contributing + +We love pull requests from everyone. By participating in this project, you +agree to abide by the contributor covenant suggested [code of conduct]. + +[code of conduct]: https://github.com/HaoZeke/base16-zathura/blob/master/CODE_OF_CONDUCT.md + +Do make sure to run tests and generally **BE PREPARED** to have your code vetted and +checked. Do **NOT** submit code you would not be prepared to defend or maintain, +unless you are fixing a bug. + +Push to your fork and [submit a pull request][pr]. + +[pr]: https://github.com/HaoZeke/base16-zathura/compare + +At this point you're waiting on us. We like to at least comment on pull requests +within four business days (and, typically, three business day). We may suggest +some changes or improvements or alternatives. + +Some things that will increase the chance that your pull request is accepted: + +- Write tests. +- Follow the commit-style below. + +## Commit Style + +A sample **good commit** is: + +``` +fileName: Thing I did +Some subHeading things + +So this change was to do that thing I thought was good. Also there was this +other person who thought so too, so then I ate a sandwich and we got the code +done. I am writing this but really, honestly, two people did this. + + +Co-authored-by: Joel Doe <joel@iexistreally.com> +``` + +As is evident, the commit should clearly have: + +- The name of the file, or the topic or the subject you have changed or the + namespace or the functionality you have added **something:** +- A line describing **something:** +- An _(optional)_ subheading with more details +- An _(optional)_ paragraph or essay on why the change was done and anything else you want to share with the devs. +- **Co-authorship** IS MANDATORY if applicable. Even if you just had a sandwich with the other person. It won't kill you to share, or to write that. + +<!-- * Follow our [style guide][style]. --> + +<!-- [style]: https://github.com/thoughtbot/guides/tree/master/style --> |
