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.

Sign up for GitHub

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

Create default CONTRIBUTING guide #2

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Create default CONTRIBUTING guide #2

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b64b37
Add initial generic contributing guide
carpeliam Jul 31, 2019
1efdd69
Correct broken links to github pages
carpeliam Jul 31, 2019
b17be20
On second thought, remove links to Issues/PRs
carpeliam Aug 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 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 - 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/)