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

provide an org level CONTRIBUTING guide #27

Open
travi opened this issue Jan 13, 2018 · 6 comments
Open

provide an org level CONTRIBUTING guide #27

travi opened this issue Jan 13, 2018 · 6 comments

Comments

@travi
Copy link
Member

travi commented Jan 13, 2018

we've recently added quite a bit of automation and process rigidity to support that automation to some of the projects that support the primary tasks of the org (mostly around the new site, but this may grow into other areas as well).

while most of this should work technically with little more than nvm install / nvm use and npm it, there are some surprises that will likely catch an outside contributor off guard. we should outline any machine setup that is either necessary or helpful in a common place that can be linked to from all of the various projects. each project may also have their own .github/CONTRIBUTING.md with any repo specific details, but those should link to the common doc for common info.

Examples to consider:

@travi

This comment has been minimized.

@travi

This comment has been minimized.

@travi

This comment has been minimized.

@micleners
Copy link
Member

micleners commented Oct 13, 2019

It would be helpful for contributors to include additional information around git cz expectations:

  • commit message types (fix, bug, feat, chore, etc.) and what they are associated with
  • the resulting semver change if a PR gets merged with a specific type
  • expectations around commit messages

Some of this information is available here: https://www.conventionalcommits.org/en/v1.0.0/

@travi

This comment has been minimized.

@travi
Copy link
Member Author

travi commented Nov 19, 2019

here's a great example laying out how following the commit convention triggers various releases: https://github.com/probot/probot/blob/master/CONTRIBUTING.md#merging-the-pull-request--releasing-a-new-version

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

No branches or pull requests

2 participants