Skip to content

Update Contributing guidelines #3563

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

Open
lomky wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Contributing guidelines #3563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 0 additions & 16 deletions .github/CONTRIBUTING
View file
Open in desktop

This file was deleted.

33 changes: 33 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## How to be an awesome contributor to this project

### Implementing features

* Our [list of issues in Github](https://github.com/DARIAEngineering/dcaf_case_management/issues) is our project's TODO list
* Post in an issue when you're starting work on something, so @colinxfleming or @lomky can keep on top of things
* Focus on fixing one issue per PR.
* If needed, break up a PR into multiple PRs, and add the order of commit into the description
* If you're stuck, ask the [Civic Tech DC #daria slack channel](https://civictechdc.org/resources/slack.html)! There are a number of experienced programmers who are happy to help with learning and troubleshooting.
* Please limit the number of PRs opened in a short timeframe.
* Please only open PRs for existing issues.
* If you have an idea for a feature, open an issue for discussion and a go-ahead before writing the code.
* We are a fund-led project first and foremost, new features are implemented at their request and for their benefit.

### Are you new and looking to dive in?

We love beginners and new programmers! We recognize that not everyone comes to this project intimately familiar with rails. **If you've got the time and energy to contribute, we've got the time to help guide you in the right direction and make sure your time is well spent.** We've also got a set of issues that [are good starting points](https://github.com/DARIAEngineering/dcaf_case_management/issues?q=is%3Aissue+is%3Aopen+label%3A%22beginner+friendly%22) if you're fresh to this project.

We've tried to structure the project in such a way that minimal specialized knowledge is required to contribute; we use the default Rails stack wherever possible, with the exception a couple gems.

Check out the [Documentation!](_docs/)!

### Security Practices

* Please see [this document](_docs/SECURITY_INTRO.md) for good security practices


### Agent Assisted Coding

* Human commiters are ultimately responsible for the commits in their PR
* Please review all code changes and do not submit changes without first understanding the implications of a PR.
* The codebase should remain human readable and beginner friendly, please follow the codebase norms.
* PR Reviews will be done by one of the maintainers of the codebase, and agent-assisted changes may be rejected at their discretion, especially in secure or sensitive areas of the code.
20 changes: 2 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Get started with the how-and-why of the project by checking out [Abortion funds]

You can also check out [some of the other buzz](_docs/PRESS.md) or [read about how it's impacted DCAF](_docs/IMPACT_ON_DCAF.md).

There's still work to do, but generally we're pretty stable these days. Our general administration/maintenance plan is [here](_docs/ADMINISTRATION_AND_MAINTENANCE_PLAN.md).
While there's always work to do, we're focused first on being a stable app for our funds. Our priorities are dependency upgrades, technical stability and security improvements, and fund requested features.

## Sandbox Staging Environment

Expand All @@ -27,7 +27,7 @@ Password: AbortionsAreAHumanRight1

## Project Setup

[We have detailed instructions on how to get started here!](_docs/SETUP.md)
We have detailed instructions on [how to get started here](_docs/SETUP.md) and [contribution guidelines here!](CONTRIBUTING.md)

## Who's in charge here?
The team leads are:
Expand All @@ -38,22 +38,6 @@ The team leads are:

Feel free to hit any of us up with questions about the project, we're nice!

## Contributing to this Project

### tl;dr
* We are best reached via the [Civic Tech DC slack](https://civictechdc.org/resources/slack.html)
* We run on forks and pull requests
* Our [list of issues in Github](https://github.com/DARIAEngineering/dcaf_case_management/issues) is our project's remaining TODO list
* Post in an issue when you're starting work on something, so @colinxfleming can keep track of it and so we don't duplicate work
* We <3 new people and beginners

### We <3 new people and beginners!
We recognize that not everyone comes to this project intimately familiar with rails. **If you've got the time and energy to contribute, we've got the time to help guide you in the right direction and make sure your time is well spent.** We've also got a set of issues that [are good starting points](https://github.com/DARIAEngineering/dcaf_case_management/issues?q=is%3Aissue+is%3Aopen+label%3A%22beginner+friendly%22) if you're fresh to this project.

We've tried to structure the project in such a way that minimal specialized knowledge is required to contribute; we use the default Rails stack wherever possible, with the exception a couple gems.

**We prioritize inclusivity of all skill levels on this project** -- if you are willing to put in the time to learn, a team member will be willing to work with you to make it happen!

## Project Appreciation ✨

Like all volunteer projects, we'd be dead in the water if it weren't for the hard work of our valuable team. We are eternally grateful to every contributor, be they programmers, designers, researchers, case managers, project managers, bug hunters, documenters, or anyone else keeping us afloat!
Expand Down
26 changes: 6 additions & 20 deletions _docs/SETUP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,14 @@ If you see a spot in the docs that's confusing or could be improved, please pay
2. Clone the repo to your machine: Copy the URL for your fork and run: `git clone YOUR_FORK_URL` to pull it down to your local system. Change into the repo directory with `cd dcaf_case_management`.
3. Add the Daria repo as a remote: `git remote add upstream https://github.com/DARIAEngineering/dcaf_case_management`. This will let you update when the source repo changes by running the command `git pull upstream main`.

## Local Development

## Local Dev Environment
### Docker-based

For the rest of the setup, you have two options: Docker, or installing everything locally. We recommend Docker if you're comfortable with its ecosystem.
We've dockerized the app, to manage the dependencies and save us some headache. We recommend this route for beginners or anyone who prefers docker.
If you've got [Docker installed already](https://docs.docker.com/engine/installation/), you can be up and running with three commands:

### Docker

We've dockerized this app, to manage the dependencies and save us some headache. If you've got [Docker installed already](https://docs.docker.com/engine/installation/), you can be up and running with three commands:

* `docker compose build # (this may say 'uses an image, skipping' a few times, that's OK)`
* `docker compose build`
* `docker compose run --rm web rails db:drop db:create db:migrate db:seed # to populate the database`
* `docker compose up`

Expand All @@ -33,22 +31,10 @@ take a minute or two for resources to compile and load, but it should eventually

Any errors will show up in your terminal in the window you are running the `up` command in.

If the server won't start, it may not have cleanly shut down. Run `rm tmp/pids/server.pid` to remove the leftover server process and run `docker compose up` again.

If you're using a Windows 10 machine to run docker, we strongly suggest downloading and using [Docker-Desktop](https://www.docker.com/products/docker-desktop).
The Docker-Desktop experience on Windows 10 is mostly very smooth these days, but there are a couple common "gotchas" we've seen while developing this (and other) apps. One of our core maintainers keeps additional info on this [here](https://github.com/mdworken/MKD-Docker-Windows-Rails). If you run into issues that are not covered there, or if you have suggestions to improve the readability of the repo, please let us know! We're happy to help debug, and once we understand the issues you've seen, you'll have helped future users who may encounter the same issue.

To fix this, you need to enable experimental features for Docker:
1. Right click Docker icon in the Windows System Tray
2. Go to Settings
3. Go to Daemon
4. Check Experimental features
5. Hit Apply


### Local Laptop Install

If you prefer a local environment, totally cool! We recommend the following, but you'll need to adapt to your exact machine.
If you prefer to run directly on you machine, here are our general directions. You may need to adapt them to your machine. Beginners may find the docker setup easier.

#### System Dependencies
* Install:
Expand Down
Loading