From c5b44cdfc22d35ddbdcf7068e491cf825fbd2ab7 Mon Sep 17 00:00:00 2001 From: Merlin Mathesius Date: Aug 17 2017 22:02:37 +0000 Subject: [PATCH 1/2] Add CONTRIBUTING and CODE_OF_CONDUCT documents --- diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..be57bac --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# 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 the project team at . 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 [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..01cd01e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributor Guidelines + +## Code of Conduct + +Our [Code of Conduct](CODE_OF_CONDUCT.md) means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code. + +## How can I contribute? + +If you are looking to help with a code contribution, that's great! The `standard-test-roles` project uses ansible and python scripting. If you want to help but don't feel you can make a code contribution yet, please write some tests for your favorite Fedora packages using `standard-test-roles`. + +If you are interested in making a contribution and would like to learn more about how `standard-test-roles` is used and the technologies that it uses, check out the following: + +* [Fedora Continuous Integration Tests](https://fedoraproject.org/wiki/CI/Tests) +* [Invoking Fedora Tests](https://fedoraproject.org/wiki/Changes/InvokingTests) +* [Ansible](http://docs.ansible.com/ansible/) +* [Ansible playbooks](http://docs.ansible.com/ansible/playbooks.html) + +## Where can I go for help? + +If you need help, here are the places where you can ask questions: + +* Mailing list: ([archive](https://lists.fedoraproject.org/admin/lists/ci.lists.fedoraproject.org/)) +* IRC: [chat.freenode.net channel #fedora-ci](https://webchat.freenode.net/?channels=#fedora-ci). + +## Submitting changes + +Open a [pagure Pull Request to `standard-test-roles`](https://pagure.io/standard-test-roles/pull-requests) with a clear explanation of what you've done and why. (Read more about [pagure pull requests](https://docs.pagure.org/pagure/usage/pull_requests.html).) + +Please be sure to write clear log messages for your commits. One-line messages are fine for small changes, but bigger changes should generally contain many more details. + +## Style guidelines + +_TBD_ From 9c94bea24da4b5eb995cd2443da5a02ff92005b1 Mon Sep 17 00:00:00 2001 From: Merlin Mathesius Date: Sep 06 2017 21:39:59 +0000 Subject: [PATCH 2/2] Updates to CONTRIBUTING guide based on feedback --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01cd01e..3005e72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,31 +2,46 @@ ## Code of Conduct -Our [Code of Conduct](CODE_OF_CONDUCT.md) means that you are responsible for treating everyone on the project with respect and courtesy regardless of their identity. If you are the victim of any inappropriate behavior or comments as described in our Code of Conduct, we are here for you and will do the best to ensure that the abuser is reprimanded appropriately, per our code. +Our [Code of Conduct](CODE_OF_CONDUCT.md) means that you are responsible for +treating everyone on the project with respect and courtesy regardless of their +identity. If you are the victim of any inappropriate behavior or comments as +described in our Code of Conduct, we are here for you and will do the best to +ensure that the abuser is reprimanded appropriately, per our code. ## How can I contribute? -If you are looking to help with a code contribution, that's great! The `standard-test-roles` project uses ansible and python scripting. If you want to help but don't feel you can make a code contribution yet, please write some tests for your favorite Fedora packages using `standard-test-roles`. +If you are looking to help with a code contribution, that's great! +The `standard-test-roles` project uses ansible and python scripting. +If you want to help but don't feel you can make a code contribution yet, +please write some tests for your favorite Fedora packages using `standard-test-roles`. -If you are interested in making a contribution and would like to learn more about how `standard-test-roles` is used and the technologies that it uses, check out the following: +If you are interested in making a contribution and would like to learn more +about how `standard-test-roles` is used and the technologies that it uses, +check out the following: * [Fedora Continuous Integration Tests](https://fedoraproject.org/wiki/CI/Tests) * [Invoking Fedora Tests](https://fedoraproject.org/wiki/Changes/InvokingTests) * [Ansible](http://docs.ansible.com/ansible/) * [Ansible playbooks](http://docs.ansible.com/ansible/playbooks.html) +* [Using Multiple Dynamic Inventory Sources with Ansible](http://docs.ansible.com/ansible/latest/intro_dynamic_inventory.html#using-inventory-directories-and-multiple-inventory-sources) +* [Developing Dynamic Inventory Sources for Ansible](http://docs.ansible.com/ansible/latest/dev_guide/developing_inventory.html) ## Where can I go for help? If you need help, here are the places where you can ask questions: -* Mailing list: ([archive](https://lists.fedoraproject.org/admin/lists/ci.lists.fedoraproject.org/)) * IRC: [chat.freenode.net channel #fedora-ci](https://webchat.freenode.net/?channels=#fedora-ci). +* Mailing list: ([archive](https://lists.fedoraproject.org/admin/lists/ci.lists.fedoraproject.org/)) ## Submitting changes -Open a [pagure Pull Request to `standard-test-roles`](https://pagure.io/standard-test-roles/pull-requests) with a clear explanation of what you've done and why. (Read more about [pagure pull requests](https://docs.pagure.org/pagure/usage/pull_requests.html).) +Open a [pagure Pull Request to `standard-test-roles`](https://pagure.io/standard-test-roles/pull-requests) +with a clear explanation of what you've done and why. (Read more about +[pagure pull requests](https://docs.pagure.org/pagure/usage/pull_requests.html).) -Please be sure to write clear log messages for your commits. One-line messages are fine for small changes, but bigger changes should generally contain many more details. +Please be sure to write clear log messages for your commits. One-line messages +are fine for small changes, but bigger changes should generally contain many +more details. ## Style guidelines