Skip to content

Commit bb0ebee

Browse files
Merge pull request #185 from CodeForPhilly/mishmosh/contributing
Update CONTRIBUTING.md
2 parents eb5ca8b + 2d0b461 commit bb0ebee

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/CONTRIBUTING.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@ Welcome, grab a cup of coffee, and let's roll our sleeves up! By participating i
44

55
## What should I work on?
66

7-
As of March 19, help is especially wanted in these areas:
8-
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)
7+
Our project work is organized by 4 main areas:
8+
9+
| Area | What type of help wanted? | Project Board | Slack channel | Maintainers |
10+
| --- | --- | --- | --- | --- |
11+
| App Platform | Python wizards to work on application development, hardening the code, making it more flexible, and unit testing | [Board](https://github.com/CodeForPhilly/chime/projects/3) | [#chime-app](https://codeforphilly.org/chat?channel=chime-app) | @quinndougherty |
12+
| Analysis | Epidemiologists and other math and stats friends, for model improvements | [Board](https://github.com/CodeForPhilly/chime/projects/5) | [#chime-analysis](https://codeforphilly.org/chat?channel=chime-analysis) | @sam-qordoba, @cjbayesian |
13+
| DevOps | DevOps heroes (especially if you have Kubernetes experience) for hosting, maintenance, and ensuring easy redeploys. | [Board](https://github.com/CodeForPhilly/chime/projects/2) | [#chime-ops](https://codeforphilly.org/chat?channel=chime-ops) | @moosequest, @themightychris, @lottspot |
14+
| General Project Ops | Writing, documentation, and project and product management | [Board](https://github.com/CodeForPhilly/chime/projects/6) | | @mariekers |
15+
16+
As of March 21, help is especially wanted from contributors with experience in Kubernetes and Python.
1817

1918
## Before You Begin
2019

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).
20+
- Join the [#covid19-chime-penn](https://codeforphilly.org/chat?channel=covid19-chime-penn) channel for project-wide announcements.
21+
- Our highest-priority work is organized in [Github Project Boards](https://github.com/CodeForPhilly/chime/projects). Look for an issue matching your interests & skills in the "Ready" columns.
22+
- Comment on the issue to let us know you're picking it up, briefly describe your plan, and go forth!
23+
- For new ideas, please first discuss the change(s) you wish to make via [issue](https://github.com/codeforphilly/chime/issues) or the appropriate Slack channel (see table above).
2524

2625
## Making and Submitting Changes
2726

2827
- [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [CodeforPhilly/chime](https://github.com/CodeForPhilly/chime) repo.
2928
- Base your work on the `develop` branch.
3029
- Submit pull requests from your fork, also against the `develop` branch of the `CodeforPhilly/chime` repo.
30+
- Request review from the relevant maintainer(s).
3131
- Check your pull request periodically to see if any changes have been requested or any merge conflicts have arisen.
3232
- 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.
3333
- Note: Frequent contributors with write access can submit pull requests from a new branch in the `CodeforPhilly/chime` repository.
@@ -39,8 +39,8 @@ As of March 19, help is especially wanted in these areas:
3939
- Maintainers will review pull requests, asking for changes as needed.
4040
- Once a PR has 1 approval and passes automated tests, maintainers will merge to release branches.
4141
- 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.
42+
- Deploys to production must be signed off by @beckerfluffle or @cchivers.
4343

4444
## Requesting Functionality
4545

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.
46+
**Stakeholders/Users**: Check the [#chime-users](https://codeforphilly.org/chat/chime-users) channel on [Slack](https://codeforphilly.org/chat) to see if your need is already being addressed.

0 commit comments

Comments
 (0)