Skip to content

Contributing

Jump to bottom
Daniel Reeves edited this page May 8, 2020 · 10 revisions

We appreciate that you want to contribute to the Flagging project! There are various ways to contribute to the project, outlined in this document.

The vast majority of contributions to the Flagging site will be code contributions. If you would like to contribute to the Safe Water Project in general, which has more coding and non-coding opportunities to contribute, say hi in our Slack, join our Tuesday meetings, and talk to one of the Safe Water Project's coordinators at the meetings.

What to Contribute

For now, read the wiki page about our goals to get an idea of what we need, and join us on our Tuesday night meetings.

Once the website has an MVP, we will start utilizing the GitHub Issues and GitHub Probjects tabs in this repo to track work that needs to be performed.

How to Contribute Code

Our project follows a standard Git workflow, currently without branching.

If this is your first time working on a collaborative project with Git, check out this handy First Contributions guide.

The basic outline for making contributions is:

  1. Fork the project. (https://github.com/codeforboston/safe-water/fork)
  2. Clone your fork. (git clone https://github.com/<YOUR-USERNAME>/safe-water.git)
  3. Add a remote. (git remote add upstream https://github.com/codeforboston/safe-water.git)
  4. Checkout the master branch. (git checkout master)
  5. Make your changes! 😃
  6. Make sure your code adheres to the Code Style Guide.
  7. Add the relative path(s) of the document(s) you added/changed. (git add <MY/DOC/PATH/HERE>)
  8. Commit those changes. (git commit -m "<DESCRIBE WHAT YOU DID>")
  9. On your forked repo, submit a Pull Request to the Code for Boston's master branch.
  10. Ask someone on the Slack channel to review your Pull Request.

We will review pull requests and discuss them on Tuesday nights at the Code for Boston meetup.

Clone this wiki locally