|
1 | 1 | # Contributing
|
2 | 2 |
|
3 |
| -When contributing to this repository, please first discuss the change you wish to make via [issue](https://github.com/codeforphilly/chime/issues), [Slack chat](https://codeforphilly.org/chat/covid19-chime-penn), or any other method with the owners of this repository before making a change. |
| 3 | +Welcome, grab a cup of coffee, and let's roll our sleeves up! By participating in this project, you agree to abide by our [code of conduct](CODE_OF_CONDUCT.md). |
4 | 4 |
|
5 |
| -Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. |
| 5 | +## What should I work on? |
6 | 6 |
|
7 |
| -## Active Needs |
| 7 | +As of March 19, help is especially wanted in these areas: |
8 | 8 |
|
9 |
| -We maintain a list of [issues in the Code for Philly repo](https://github.com/codeforphilly/chime/issues) that encompasses work requested by stakeholders and technologists. Each issue is designed to be small enough for one person to implement. |
| 9 | +- **Python wizards** for application development ([#chime-app](https://codeforphilly.org/chat?channel=chime-app)) |
| 10 | + - Hardening the code |
| 11 | + - Making it more flexible |
| 12 | + - Unit tests! |
| 13 | +- **DevOps heroes** for application hosting ([#chime-ops](https://codeforphilly.org/chat?channel=chime-ops)) |
| 14 | + - Maintaining Penn's instance |
| 15 | + - Ensuring easy redeploys |
| 16 | +- **Math and stats friends** for model improvements ([#chime-analysis](https://codeforphilly.org/chat?channel=chime-analysis)) |
| 17 | +- **Consulting DevOps champs** to help other public agencies set up their own instances ([#chime-help](https://codeforphilly.org/chat?channel=chime-help) |
10 | 18 |
|
11 |
| -**Developers** If you are new to the project, check out open issues to see if there is any pre-existing work needed that you can handle. We will need to add your git account to the repo to grant write access - contact us on [Slack](https://codeforphilly.org/chat) in the [covid19-chime-penn](https://codeforphilly.org/chat?channel=covid19-chime-penn) channel. |
| 19 | +## Before You Begin |
12 | 20 |
|
13 |
| -## Change Management |
| 21 | +- Join the [#covid19-chime-penn](https://codeforphilly.org/chat?channel=covid19-chime-penn) channel, and [request write access](https://codeforphilly.slack.com/archives/CV4NGQYMP/p1584665484368300) to the `CodeforPhilly/chime` Github repository. |
| 22 | +- Our highest-priority work is organized in the [Github Project Management board](https://github.com/CodeForPhilly/chime/projects/2). Look for an issue matching your interests & skills in one of the "Ready" columns. |
| 23 | +- Assign yourself to the issue and add a comment to briefly describe your plan. |
| 24 | +- For new ideas, please first discuss the change(s) you wish to make via [issue](https://github.com/codeforphilly/chime/issues) or appropriate Slack channel (platform/app - #chime-app, devops - #chime-ops, modeling - #chime-analysis). |
14 | 25 |
|
15 |
| -- Base all work on the latest `develop` branch available in [Code for Philly's fork of the `chime` repository](https://github.com/CodeForPhilly/chime). |
16 |
| -- Submit your work in the form of a pull request against that same branch. |
17 |
| -- Check in on your pull request periodically after you submit it to see if any changes have been requested or any merge conflicts have arisen from other work getting integrated. |
18 |
| -- If a merge conflict arises, please rebase your branch against the latest `develop` branch and force-push the new branch as early as you can. You may need to do this more than once before your changes get merged. Do your best to keep your branch in a mergeable state until it is finished being reviewed and accepted. |
| 26 | +## Making and Submitting Changes |
| 27 | + |
| 28 | +- [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [CodeforPhilly/chime](https://github.com/CodeForPhilly/chime) repo. |
| 29 | +- Base your work on the `develop` branch. |
| 30 | +- Submit pull requests from your fork, also against the `develop` branch of the `CodeforPhilly/chime` repo. |
| 31 | +- Check your pull request periodically to see if any changes have been requested or any merge conflicts have arisen. |
| 32 | +- If a merge conflict arises, rebase against the latest `develop` branch and force-push the new branch as early as you can. You may need to do this more than once before your changes get merged. Do your best to keep your branch in a mergeable state until it is finished being reviewed and accepted. |
| 33 | +- Note: Frequent contributors with write access can submit pull requests from a new branch in the `CodeforPhilly/chime` repository. |
| 34 | + |
| 35 | +## Review & Release |
| 36 | + |
| 37 | +<!-- Currently establishing & clarifying the release process, this is just a skeleton. --> |
| 38 | + |
| 39 | +- Maintainers will review pull requests, asking for changes as needed. |
| 40 | +- Once a PR has 1 approval and passes automated tests, maintainers will merge to release branches. |
| 41 | + - Exception: Documentation or infrastructure support PRs can be merged directly to master. |
| 42 | +- Deploys to production must be signed off on by @beckerfluffle or @cchivers. |
19 | 43 |
|
20 | 44 | ## Requesting Functionality
|
21 | 45 |
|
22 |
| -**Stakeholders/Users** Find us on [Slack](https://codeforphilly.org/chat) in the [#covid19-chime-penn](https://codeforphilly.org/chat/covid19-chime-penn) channel to see if your need is already being addressed. |
| 46 | +**Stakeholders/Users**: Check the [#covid19-chime-penn](https://codeforphilly.org/chat/covid19-chime-penn) channel on [Slack](https://codeforphilly.org/chat) to see if your need is already being addressed. |
0 commit comments