dsmjs / .github

MIT License
0 stars 1 forks source link

provide an org level CONTRIBUTING guide #27

Open travi opened 6 years ago

travi commented 6 years ago

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 commented 6 years ago

we might want to consider not naming this org-level one as .github/CONTRIBUTING.md since github handles this in some special ways for the repo itself. plus, we might want a repo one in meta at some point, so we should leave room for that.

probably still makes sense to go under .github/? maybe .github/DSMJS-CONTIRBUTING.md?

travi commented 6 years ago

include configuration instructions for

travi commented 6 years ago

mention the git cz --retry shortcut

micleners commented 5 years ago

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

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

travi commented 5 years ago

the new intent for location of this is in the .github repo, now that github will automatically make it the default across repos that don't override it: https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization

travi commented 4 years ago

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