From 8a7ded9e0f184150d3082d786d17c6caa9af38bf Mon Sep 17 00:00:00 2001 From: Alex Laird Date: Tue, 14 Nov 2023 14:41:09 -0600 Subject: [PATCH] no message --- CODE_OF_CONDUCT.md | 77 ++++++++++++++++++++++++++++++++++++++++++++++ CONTRIBUTING.rst | 18 +++++++++++ README.md | 8 +++++ 3 files changed, 103 insertions(+) create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTING.rst diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..63e2775 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,77 @@ +# 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, 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 [contact@alexlaird.com][mailto]. +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 . + +For answers to common questions about this code of conduct, see +. + +[homepage]: https://www.contributor-covenant.org +[mailto]: mailto:contact@alexlaird.com diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..538454d --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,18 @@ +Contributing +============ + +If you find issues, `report them on GitHub `_. + +If you would like to contribute to the code, the process is pretty simple: + +1. Familiarise yourself with the code. +2. Fork `the repository on GitHub `_ and start implementing changes. +3. Write a test that plainly validates the changes made. +4. Build and test locally with ``make test`` +5. Submit a `pull requests `_ to get the changes merged. + +Also be sure to review the `Code of Conduct `_ before +submitting issues or pull requests. + +Want to contribute financially? If you've found the Air Quality Bot useful, `sponsorship `_ +would also be greatly appreciated! diff --git a/README.md b/README.md index be1a8ae..80b4fea 100644 --- a/README.md +++ b/README.md @@ -149,3 +149,11 @@ can easily be redeployed at any time by rerunning the deploy script: ```sh ./deploy.sh ``` + +## Contributing + +If you would like to get involved, be sure to review the [Contribution Guide](https://github.com/alexdlaird/air-quality-bot/blob/main/CONTRIBUTING.rst). + +Want to contribute financially? If you've found `pyngrok` useful, [sponsorship](https://github.com/sponsors/alexdlaird) would +also be greatly appreciated! +