diff --git a/.github/FEATURE_REQUEST.md b/.github/FEATURE_REQUEST.md new file mode 100644 index 0000000..dce1cae --- /dev/null +++ b/.github/FEATURE_REQUEST.md @@ -0,0 +1,34 @@ +--- +name: Feature request +about: Suggest a feature for this project + +--- + +NOTE: Each discrete (stand-alone) request should be in its own issue. + +**Give a clear and concise description of the problem.** + +``` + +``` + +**Describe the solution you'd like.** + +``` + +``` + +**Describe alternatives you've considered.** + +``` + +``` + + +### Issue Checklist + +Put an x in the boxes once you've completed each step. You can also fill these out after creating the issue. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before responding to the issue. + +- [ ] I have checked for other similar issues +- [ ] I have explained why this change is important +- [ ] I have added necessary documentation (if appropriate) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ef94772 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,46 @@ +# Contributor Covenant 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, gender identity and expression, level of experience, 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 both within project spaces and in public spaces when an individual is representing the project or its community. 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 me at [aaronlichtman@gmail.com](mailto:aaronlichtman@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://contributor-covenant.org/version/1/4][version] + +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3278d76 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing + +First off, thanks for taking the time to contribute! + +The following is a set of guidelines for contributing. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. + +#### Table Of Contents + +1. [Code of Conduct](#code-of-conduct) +1. [Styleguides](#styleguides) + + [Content](#content) + + [Issues](#issues) + + [Pull Requests](#pull-requests) + + [Commit Messages](#commit-messages) + + +## Code of Conduct + +This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [aaronlichtman@gmail.com](mailto:aaronlichtman@gmail.com). + +## Styleguides + +#### Code + +* Try to write your code following the style in the repo already. + +#### Issues + +* **Use a clear and descriptive title** for the issue to identify the suggestion. +* **Provide a comprehensive description of the suggested enhancement** in as much detail as possible. +* (If applicable) **Provide specific examples to demonstrate the steps**. Include code snippets which you use in those examples, as [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). + +#### Commit Messages + +* Limit the first line to 72 characters or less +* Reference issues and pull requests + +#### Pull Requests + +* **Use a clear and descriptive title** for the issue to identify the suggestion. +* Include any relevant issue numbers in the PR body, not the title. +* **Provide a comprehensive description of all changes made.**