Merge pull request #122 from github/bensheldon/contributing-instructions

bensheldon · web-flow · commit 1567efb6849a · 2022-10-26T08:05:04.000-07:00
Add contribution instructions, code of conduct, and codeowners
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -0,0 +1 @@
+* @github/ruby-architecture-reviewers
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,73 @@
+# 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 at opensource+rubocop@github.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
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,42 @@
+# Contributing
+
+We welcome your contributions to the project. Thank you!
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+
+## What to contribute
+
+This repository, `rubocop-github`, is part of a broader RuboCop ecosystem.
+
+If the Cop you would like to propose is **generally applicable outside of GitHub**:
+
+1. Propose the change upstream in the core open source project (e.g. [`rubocop`](https://github.com/rubocop/rubocop), or [`rubocop-rails`](https://github.com/rubocop/rubocop-rails)), where it will have maximal visibility and discussion/feedback.
+1. Patch the change provisionally into GitHub's project(s), for immediate benefit; that can include this repository.
+1. ...if the proposal is accepted, remove the patch and pull the updated upstream.
+1. ...if the proposal is not accepted, we usually learn something about our proposal, and we then choose whether to maintain the patch ourselves, discard it, or identify a better open-source home for it.
+
+If the Cop is **only applicable for GitHub**, then this is the right place to propose it.
+
+## How to contribute a Pull Request
+
+1. Fork and clone the repository
+1. [Build it and make sure the tests pass](README.md#Testing) on your machine
+1. Create a new branch: `git checkout -b my-branch-name`
+1. Make your change, add tests, and make sure the tests still pass
+1. Push to your fork and submit a Pull Request
+1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
+
+## For Maintainers
+
+### Releasing a new version
+
+1. Update `rubocop-github.gemspec` with the next version number
+1. Update the `CHANGELOG` with changes and contributor
+1. Run `bundle` to update gem version contained in the lockfile
+1. Make a commit: `Release v{VERSION}`
+1. Tag the commit : `git tag v{VERSION}`
+1. Create the package: `gem build rubocop-github.gemspec`
+1. Push to GitHub: `git push origin && git push origin --tags`
+1. Push to Rubygems: `gem push rubocop-github-{VERSION}.gem`
+1. Publish a new release on GitHub: https://github.com/github/rubocop-github/releases/new
