You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,12 @@ Once a GitHub issue is accepted and assigned to you, please follow general workf
12
12
13
13
1. Fork the target repository under your GitHub username.
14
14
2. Create a branch in your forked repository for the changes you are about to make.
15
+
16
+
-`bundle install` to install the dependencies
17
+
- Make sure tests pass locally
18
+
- You'll need to spin up a few containers (redis and memcached) to run the tests. You can do this by running `docker-compose up -d` in the root of the project.
19
+
- Run tests with `COVERAGE=true bundle exec rake`
20
+
15
21
3. Commit your changes in the branch you created in step 2. All commits need to be signed-off. Check the [legal](#legal) section bellow for more details.
16
22
4. Push your commits to your remote fork.
17
23
5. Create a Pull Request from your remote fork pointing to the HEAD branch (usually `main` branch) of the target repository.
@@ -23,14 +29,14 @@ Procore projects use Developer Certificate of Origin ([DCO](https://GitHub.com/a
23
29
24
30
Please sign-off your contributions by doing ONE of the following:
25
31
26
-
* Use `git commit -s ...` with each commit to add the sign-off or
27
-
* Manually add a `Signed-off-by: Your Name <your.email@example.com>` to each commit message.
32
+
- Use `git commit -s ...` with each commit to add the sign-off or
33
+
- Manually add a `Signed-off-by: Your Name <your.email@example.com>` to each commit message.
28
34
29
35
The email address must match your primary GitHub email. You do NOT need cryptographic (e.g. gpg) signing.
30
36
31
-
* Use `git commit -s --amend ...` to add a sign-off to the latest commit, if you forgot.
37
+
- Use `git commit -s --amend ...` to add a sign-off to the latest commit, if you forgot.
32
38
33
-
*Note*: Some projects will provide specific configuration to ensure all commits are signed-off. Please check the project's documentation for more details.
39
+
_Note_: Some projects will provide specific configuration to ensure all commits are signed-off. Please check the project's documentation for more details.
0 commit comments