From 7b64b37a4d7ed716ff247d678b933843ab194136 Mon Sep 17 00:00:00 2001 From: Liam Morley Date: Tue, 30 Jul 2019 21:36:13 -0400 Subject: [PATCH 1/3] Add initial generic contributing guide --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d947a0a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing Guide + +Thanks for your interest in contributing! These notes will hopefully get you situated. + +## Team Communication + +This team (and all [Code for Boston](https://www.codeforboston.org/) teams) communicates over slack. If you haven't already done so, you'll want to [create a Code for Boston Slack account](https://communityinviter.com/apps/cfb-public/code-for-boston-slack-invite). From there you can find team members and help coordinate around work. + +You can also attend any [Code for Boston Meetup](https://www.meetup.com/Code-for-Boston/) to get together in person. + +If you're interested in getting started but not sure how to dive in, one of those two ways of getting in touch with the team is probably the best way to get started. + +## Contributing Code + +Some of the best ways to find out where to jump in are to either talk to someone on the team (see above for team communication), or look for [issues](issues) marked as [low hanging fruit](contribute). For new contributors, we suggest that you first [fork the repository](https://help.github.com/en/articles/about-forks) in order to track your changes, then create a [pull request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork). [See this guide for best practices regarding forking and creating a pull request](https://gist.github.com/Chaser324/ce0505fbed06b947d962). + +You can also get familiar with the codebase by [reviewing any outstanding pull requests](pulls) - check out [GitHub's course on pull request review best practices](https://lab.github.com/githubtraining/reviewing-pull-requests). + +Thanks again for contributing! + +--- +[Code of Conduct](https://www.codeforboston.org/code-of-conduct/) | [Code for Boston website](https://www.codeforboston.org/code-of-conduct/) | [Code for America Brigade network](https://brigade.codeforamerica.org/) From 1efdd69c4d55fa29e885d233870b0391ac7559cd Mon Sep 17 00:00:00 2001 From: Liam Morley Date: Tue, 30 Jul 2019 21:41:21 -0400 Subject: [PATCH 2/3] Correct broken links to github pages --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d947a0a..20c2bb6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,9 +12,9 @@ If you're interested in getting started but not sure how to dive in, one of thos ## Contributing Code -Some of the best ways to find out where to jump in are to either talk to someone on the team (see above for team communication), or look for [issues](issues) marked as [low hanging fruit](contribute). For new contributors, we suggest that you first [fork the repository](https://help.github.com/en/articles/about-forks) in order to track your changes, then create a [pull request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork). [See this guide for best practices regarding forking and creating a pull request](https://gist.github.com/Chaser324/ce0505fbed06b947d962). +Some of the best ways to find out where to jump in are to either talk to someone on the team (see above for team communication), or look for [issues](../../issues) marked as [low hanging fruit](../../contribute). For new contributors, we suggest that you first [fork the repository](https://help.github.com/en/articles/about-forks) in order to track your changes, then create a [pull request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork). [See this guide for best practices regarding forking and creating a pull request](https://gist.github.com/Chaser324/ce0505fbed06b947d962). -You can also get familiar with the codebase by [reviewing any outstanding pull requests](pulls) - check out [GitHub's course on pull request review best practices](https://lab.github.com/githubtraining/reviewing-pull-requests). +You can also get familiar with the codebase by [reviewing any outstanding pull requests](../../pulls) - check out [GitHub's course on pull request review best practices](https://lab.github.com/githubtraining/reviewing-pull-requests). Thanks again for contributing! From b17be20c3181b4117ebdba030a88e8652a307de8 Mon Sep 17 00:00:00 2001 From: Liam Morley Date: Wed, 31 Jul 2019 22:42:23 -0400 Subject: [PATCH 3/3] On second thought, remove links to Issues/PRs ...as this document won't exist in projects' repositories, and has to be generic --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 20c2bb6..b2b785a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,9 +12,9 @@ If you're interested in getting started but not sure how to dive in, one of thos ## Contributing Code -Some of the best ways to find out where to jump in are to either talk to someone on the team (see above for team communication), or look for [issues](../../issues) marked as [low hanging fruit](../../contribute). For new contributors, we suggest that you first [fork the repository](https://help.github.com/en/articles/about-forks) in order to track your changes, then create a [pull request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork). [See this guide for best practices regarding forking and creating a pull request](https://gist.github.com/Chaser324/ce0505fbed06b947d962). +Some of the best ways to find out where to jump in are to either talk to someone on the team (see above for team communication), or look for Issues marked with labels such as `help wanted` or `good first issue`. For new contributors, we suggest that you first [fork the repository](https://help.github.com/en/articles/about-forks) in order to track your changes, then create a [pull request](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork). [See this guide for best practices regarding forking and creating a pull request](https://gist.github.com/Chaser324/ce0505fbed06b947d962). -You can also get familiar with the codebase by [reviewing any outstanding pull requests](../../pulls) - check out [GitHub's course on pull request review best practices](https://lab.github.com/githubtraining/reviewing-pull-requests). +You can also get familiar with the codebase by reviewing any outstanding pull requests - check out [GitHub's course on pull request review best practices](https://lab.github.com/githubtraining/reviewing-pull-requests). Thanks again for contributing!