Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a contributing guide and code of conduct #284

Merged
merged 7 commits into from
Oct 1, 2020
Merged

Conversation

brendanzab
Copy link
Owner

@brendanzab brendanzab commented Sep 7, 2020

This begins work on a contributing guide, and adds a code of conduct.

I've documented my release process, but it's not the nicest. We might want to re-think it before we call #272 done, perhaps recommending cargo-release?

README.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
1. Create your contribution, meeting all [contribution quality standards](#quality-standards).
1. Ensure all the tests pass (`cargo test`).
1. [Create a pull request][create-a-pr] against the `master` branch of the repository.
1. Once the pull request is reviewed and CI passes, it will be merged.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should collaborators merge their own PRs or should they still be reviewed by someone else?

Copy link
Owner Author

@brendanzab brendanzab Sep 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I think in general it's ok for collaborators to merge them themselves if they are approved. We could maybe look at adding Mergify or Bors support if this makes things easier?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other words, there are no other limitations than the last point and collaborators can merge themself if CI passes.

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, pretty much!

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think an approved review is kind of like “I trust you to clean stuff up if I had any things I mentioned, but otherwise it looks good, merge when you're ready!”

@brendanzab brendanzab merged commit 4d2f9fd into master Oct 1, 2020
@brendanzab brendanzab deleted the contributing-guide branch October 1, 2020 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants