blob: aeaff7afe2368b67f50b2d46f0ed6e33ebe8ff00 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
# Contributing to Rack
Rack is work of [hundreds of
contributors](https://github.com/rack/rack/graphs/contributors). You're
encouraged to submit [pull requests](https://github.com/rack/rack/pulls) and
[propose features and discuss issues](https://github.com/rack/rack/issues).
## Fork the Project
Fork the [project on GitHub](https://github.com/rack/rack) and check out your
copy.
```
git clone https://github.com/(your-github-username)/rack.git
cd rack
git remote add upstream https://github.com/rack/rack.git
```
## Create a Topic Branch
Make sure your fork is up-to-date and create a topic branch for your feature or
bug fix.
```
git checkout main
git pull upstream main
git checkout -b my-feature-branch
```
## Running All Tests
Install all dependencies.
```
bundle install
```
Run all tests.
```
rake test
```
## Write Tests
Try to write a test that reproduces the problem you're trying to fix or
describes a feature that you want to build.
We definitely appreciate pull requests that highlight or reproduce a problem,
even without a fix.
## Write Code
Implement your feature or bug fix.
Make sure that all tests pass:
```
bundle exec rake test
```
## Write Documentation
Document any external behavior in the [README](README.md).
## Update Changelog
Add a line to [CHANGELOG](CHANGELOG.md).
## Commit Changes
Make sure git knows your name and email address:
```
git config --global user.name "Your Name"
git config --global user.email "contributor@example.com"
```
Writing good commit logs is important. A commit log should describe what changed
and why.
```
git add ...
git commit
```
## Push
```
git push origin my-feature-branch
```
## Make a Pull Request
Go to your fork of rack on GitHub and select your feature branch. Click the
'Pull Request' button and fill out the form. Pull requests are usually
reviewed within a few days.
## Rebase
If you've been working on a change for a while, rebase with upstream/main.
```
git fetch upstream
git rebase upstream/main
git push origin my-feature-branch -f
```
## Make Required Changes
Amend your previous commit and force push the changes.
```
git commit --amend
git push origin my-feature-branch -f
```
## Check on Your Pull Request
Go back to your pull request after a few minutes and see whether it passed
tests with GitHub Actions. Everything should look green, otherwise fix issues and
amend your commit as described above.
## Be Patient
It's likely that your change will not be merged and that the nitpicky
maintainers will ask you to do more, or fix seemingly benign problems. Hang in
there!
## Thank You
Please do know that we really appreciate and value your time and work. We love
you, really.
|
