Skip to content

Latest commit

 

History

History
65 lines (42 loc) · 4.51 KB

CONTRIBUTING.md

File metadata and controls

65 lines (42 loc) · 4.51 KB
Raw

Contributing to Community Connect

Thank you for taking the time to contribute! 👍 Please read the following sections to learn how to make the most of your time and energy when helping out with Community Connect.

⚠️ Note: Community Connect is based out of Boston and is a team within Code for Boston, our local Code for America brigade. This project is maintained and developed through weekly in-person meetups as part of the organization.

To chat with the team, join us at the next Code for Boston Meetup or connect with us at #communityconnect on our Slack workspace.

I want to...

Contribute Writing Code ⌨️

If you want to write code for the project, start by looking at issues to tackle on our backlog. Can't find anything worth working on? Consider reporting a bug or suggesting a feature. Our open issues are listed on the project's Issues tab. The best places to start are unassigned issues with the label "good first issue".

To contribute your code to the project:

  1. Fork the project (https://github.com/codeforboston/communityconnect/fork)
  2. Create a feature branch (git checkout -b feature/{{your new feature}})
  3. Commit your changes to the branch (git commit -am 'Add {{your changes}})
  4. Push to the branch (git push origin feature/{{your new feature}})
  5. Create a new Pull Request

Steps not quite clear? First time? Check out this 'first contributions' guide.

A Note on Pull Requests

A good pull request should include:

  • A description of the change being made
  • A reference to the issue being addressed
  • A brief description of how you verified your changes

If you know someone specific will be interested in your change (such as the issue reporter), add them as a reviewer! Otherwise, all pull requests will be reviewed by contributors and maintainers.

Contribute Reading Code 🖥

You can help contribute to our code base by reviewing open pull requests on the 'Pull requests' tab or by reading our current source code in the development branch.

Check out this Guide from GitHub on reviewing pull requests for further tips and suggestions.

Report a Bug 🐞

Want to report an issue or bug you've found in Community Connect? Great! Before creating an issue and submitting a bug report, be sure to search for related issues to see if the problem has already been documented. If the issue has already been reported and it is still open, add a comment to the existing issue instead of opening a new one.

Bugs are tracked as issues in our backlog. To report one, create an issue including:

  • The [bug] label
  • A clear and descriptive title of the problem
  • A description of the issue and expected outcome
  • Specific steps used to reproduce the problem (examples are welcome, especially images or code snippets!)
  • A capture of error messages or other unexpected output

Suggest a Feature 🛠

Community Connect is always growing based on user feedback and suggestions - thanks for sharing yours! Just like reporting a bug, be sure to check existing issues for the feature you're requesting - you might not be the only one!

Feature suggestions (enhancements) are also tracked as issues in our backlog. To suggest a feature or enhnacement, create an issue including:

  • The [enhancement] label
  • A clear and descriptive title of the new behavior or functionality
  • A description of the feature
  • An example depicting this feature 'in the wild' or a simple use case for this feature
  • Why this feature could be useful for you and other users