Skip to content

Commit 477cd63

Browse files
authored
Merge pull request #6557 from acrosman/contributing_updates_6556
Copy edits to Contributing guide.
2 parents 266c51b + 46ad8cd commit 477cd63

File tree

1 file changed

+38
-23
lines changed

1 file changed

+38
-23
lines changed

doc/CONTRIBUTING.md

Lines changed: 38 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,55 @@
1-
# Contributing
1+
# Contributing
2+
23
We ♥ contributors! By participating in this project, you agree to abide by the Ruby for Good [code of conduct](https://github.com/rubyforgood/code-of-conduct).
34

4-
If you have any questions about an issue, comment on the issue, open a new issue or ask in [the RubyForGood slack](https:https://join.slack.com/t/rubyforgood/shared_invite/zt-35218k86r-vlIiWqig54c9t~_LkGpQ7Q). CASA has a `#casa` channel in the Slack. Our channel in slack also contains a zoom link for office hours every day office hours are held.
5+
If you have any questions about an issue, comment on the issue, open a new issue or ask in [the RubyForGood slack](https://join.slack.com/t/rubyforgood/shared_invite/zt-35218k86r-vlIiWqig54c9t~_LkGpQ7Q). CASA has a `#casa` channel in the Slack. Our channel in slack also contains a zoom link for office hours every day office hours are held.
56

67
You won't be yelled at for giving your best effort. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contributions, and don't want a wall of rules to get in the way of that.
78

8-
## Contributing Steps
9-
### Issues
10-
All work is organized by issues.
11-
[Find issues here.](https://github.com/rubyforgood/casa/projects/1)
9+
## Contributing Steps
10+
11+
### Issues
12+
13+
All work is organized by issues.
14+
[Find issues here.](https://github.com/rubyforgood/projects/9)
15+
16+
If you would like to contribute, please ask for an issue to be assigned to you.
1217

13-
If you would like to contribute, please ask for an issue to be assigned to you.
14-
If you would like to contribute something that is not represented by an issue, please make an issue and assign yourself.
15-
Only take multiple issues if they are related and you can solve all of them at the same time with the same pull request.
18+
If you would like to contribute something that is not represented by an issue, please make an issue and assign yourself.
19+
20+
Only take multiple issues if they are related and you can solve all of them at the same time with the same pull request.
21+
22+
### Pull Requests
1623

17-
### Pull Requests
1824
If you are so inclined, you can open a draft PR as you continue to work on it.
1925

2026
1. Follow [the setup guide](https://github.com/rubyforgood/casa#installation) to get the project working locally.
2127

22-
1. We only accept pull requests with passing tests, and it's great to know that you have a clean slate. To run the tests use `bundle exec rspec`
28+
1. We only accept pull requests with passing tests. To ensure your setup is working before you get started it's great to run the tests first.
29+
30+
- To run the tests use: `bundle exec rspec`
2331

24-
1. Add a test for your change. If you are adding functionality or fixing a bug, you should add a test!
32+
1. Add a test for your change. If you are adding functionality or fixing a bug, you should add a test!
2533

26-
1. Run linters and fix any linting errors that come up.
27-
- (from the repo root) `./bin/git_hooks/lint`
34+
1. Run linters and fix any linting errors that come up.
35+
36+
- From the repo root run: `./bin/git_hooks/lint`
2837

2938
1. Push to your branch/fork and submit a pull request. Include the issue number (ex. `Resolves #1`) in the PR description. This will ensure the issue gets closed automatically when the pull request gets merged.
3039

3140
#### Pull Request Checks
32-
There are scripts that check the code to ensure the code is working. Most of them need to pass. You can see the scripts run at the bottom of your pull request webpage. More about the scripts [here](https://github.com/rubyforgood/casa/wiki/Pull-Request-Checks). Pull requests are also manually reviewed. We may request changes after a manual review. We will try to respond to your PR quickly.
33-
34-
Some qualities of good pull requests:
35-
* Small line diff count. Several small pull requests for a large issue are preferred over one big pull request.
36-
* Include tests that fail without your code, and pass with it.
37-
* For pull requests changing UI, make sure the UI matches the rest of the site. Some of our users aren't great with computers and we don't want to make them learn new things if we don't need to.
38-
* Update the documentation, for things like new rails/bash commands. Please include a guide if modifying the code in the future is difficult. For example [editing .docx templates](https://github.com/rubyforgood/casa/wiki/How-to-edit-docx-templates---word-document-court-report) is difficult because the documentation is hard to find and it requires microsoft word.
39-
* If your pull request involves user permissions, use [policy files](https://github.com/varvet/pundit#policies).
40-
* If your pull request has an erb file with complex rails logic inside of it, please use a [decorator](https://medium.com/@kosovacsedad/ruby-on-rails-decorator-design-pattern-b54a1afd03c8).
41+
42+
We will try to respond to your PR quickly.
43+
44+
There are scripts that check the code to ensure the code is working. Most of them need to pass. You can see the scripts run at the bottom of your pull request webpage (learn more about the scripts [here](https://github.com/rubyforgood/casa/wiki/Pull-Request-Checks)). You should attempt to fix errors found in the automated testing.
45+
46+
Pull requests are also manually reviewed. We may request changes after a manual review.
47+
48+
Some qualities of good pull requests:
49+
50+
- Small line diff count. Several small pull requests for a large issue are preferred over one big pull request.
51+
- Include tests that fail without your code, and pass with it.
52+
- For pull requests changing UI, make sure the UI matches the rest of the site. Some of our users aren't great with computers and we don't want to make them learn new things if we don't need to.
53+
- Update the documentation, for things like new rails/bash commands. Please include a guide if modifying the code in the future is difficult. For example [editing .docx templates](https://github.com/rubyforgood/casa/wiki/How-to-edit-docx-templates---word-document-court-report) is difficult because the documentation is hard to find and it requires microsoft word.
54+
- If your pull request involves user permissions, use [policy files](https://github.com/varvet/pundit#policies).
55+
- If your pull request has an erb file with complex rails logic inside of it, please use a [decorator](https://medium.com/@kosovacsedad/ruby-on-rails-decorator-design-pattern-b54a1afd03c8).

0 commit comments

Comments
 (0)