]> git.openstreetmap.org Git - rails.git/blob - CONTRIBUTING.md
Merge remote-tracking branch 'upstream/pull/5286'
[rails.git] / CONTRIBUTING.md
1 * https://www.ruby-lang.org/ - The homepage of Ruby which has more links and some great tutorials.
2 * https://rubyonrails.org/ - The homepage of Rails, also has links and tutorials.
3
4 ## Coding style
5
6 We use [Rubocop](https://github.com/rubocop-hq/rubocop) (for ruby files)
7 and [ERB Lint](https://github.com/Shopify/erb-lint) (for erb templates)
8 to help maintain consistency in our code. You can run these utilities during
9 development to check that your code matches our guidelines:
10
11 ```
12 bundle exec rubocop
13 bundle exec rails eslint
14 bundle exec erblint .
15 ```
16
17 You can also install hooks to have git run checks automatically when
18 you commit using [overcommit](https://github.com/sds/overcommit) with:
19
20 ```
21 bundle exec overcommit --install
22 ```
23
24 ## Testing
25
26 Having a good suite of tests is very important to the stability and
27 maintainability of any code base. The tests in the `openstreetmap-website` code are
28 by no means complete, but they are extensive, and must continue to be
29 so with any new functionality which is written. Tests are also useful
30 in giving others confidence in the code you've written, and can
31 greatly speed up the process of merging in new code.
32
33 When contributing, you should:
34
35 * Write new tests to cover the new functionality you've added.
36 * Where appropriate, modify existing tests to reflect new or changed
37 functionality.
38 * Never comment out or remove a test just because it doesn't pass.
39
40 You can run the existing test suite with:
41
42 ```
43 bundle exec rails test:all
44 ```
45
46 You can run javascript tests with:
47
48 ```
49 bundle exec teaspoon
50 ```
51
52 You can view test coverage statistics by browsing the `coverage` directory.
53
54 The tests are automatically run on Pull Requests and other commits via github
55 actions. The results shown are within the PR display on github.
56
57 ## Static Analysis
58
59 We also perform static analysis of our code. You can run the analysis yourself with:
60
61 ```
62 bundle exec brakeman -q
63 ```
64
65 ## Comments
66
67 Sometimes it's not apparent from the code itself what it does, or,
68 more importantly, **why** it does that. Good comments help your fellow
69 developers to read the code and satisfy themselves that it's doing the
70 right thing.
71
72 When contributing, you should:
73
74 * Comment your code where necessary - explain the bits which
75 might be difficult to understand what the code does, why it does it
76 and why it should be the way it is.
77 * Check existing comments to ensure that they are not misleading.
78
79 ## i18n
80
81 If you make a change that involve the locale files (in `config/locales`) then please
82 only submit changes to the `en.yml` file. The other files are updated via
83 [Translatewiki](https://translatewiki.net/wiki/Translating:OpenStreetMap) and should
84 not be included in your pull request.
85
86 ### Copyright attribution
87
88 The list of attributions on the /copyright page is managed by the [OSMF Licensing
89 Working Group (LWG)](https://wiki.osmfoundation.org/wiki/Licensing_Working_Group).
90
91 If you want to add another attribution, or make changes to the text of an existing
92 attribution, please follow these steps:
93
94 * First, contact the LWG to discuss your proposed changes.
95 * If the LWG approves, please create a pull request with your proposed changes.
96 * Finally, please ask the LWG to formally approve the wording used in the pull request
97   (by having an LWG member comment on the PR).
98
99 When we have formal confirmation from LWG, we can go ahead and merge the PR.
100
101 ## Committing
102
103 When you submit your changes, the project maintainers have to read them and
104 understand them. This is difficult enough at the best of times, and
105 misunderstanding commits can lead to them being more difficult to
106 merge. To help with this, when committing you should:
107
108 * Split up large commits into smaller units of functionality.
109 * Keep your commit messages relevant to the changes in each individual
110 commit.
111
112 When writing commit messages please try and stick to the same style as
113 other commits, namely:
114
115 * A one line summary, starting with a capital and with no full stop.
116 * A blank line.
117 * Full description, as proper sentences with capitals and full stops.
118
119 For simple commits the one line summary is often enough and the body
120 of the commit message can be left out.
121
122 ## Pull Requests
123
124 If you have forked on GitHub then the best way to submit your patches is to
125 push your changes back to GitHub and then send a "pull request" on GitHub.
126
127 If your pull request is small, for example one or two commits each containing
128 only a few lines of code, then it is easy for the maintainers to review.
129
130 If you are creating a larger pull request, then please help the maintainers
131 with making the reviews as straightforward as possible:
132
133 * The smaller the PR, the easier it is to review. In particular if a PR is too
134   large to review in one sitting, or if changes are requested, then the
135   maintainer needs to repeatedly re-read code that has already been considered.
136 * The commit history is important. This is a large codebase, developed over many
137   years by many developers. We frequently need to read the commit history (e.g.
138   using `git blame`) to figure out what is going on. So small, understandable,
139   and relevant commits are important for other developers looking back at your
140   work in future.
141
142 If you are creating a large pull request then please:
143
144 * Consider splitting your pull request into multiple PRs. If part of your work
145   can be considered standalone, or is a foundation for the rest of your work,
146   please submit it separately first.
147 * Avoid including "fixup" commits. If you have added a fixup commit (for example
148   to fix a rubocop warning, or because you changed your own new code) please
149   combine the fixup commit into the commit that introduced the problem.
150   `git rebase -i` is very useful for this.
151 * Avoid including "merge" commits. If your PR can no longer be merged cleanly
152   (for example, an unrelated change to Gemfile.lock on master now conflicts with
153   your PR) then please rebase your PR onto the latest master. This allows you to
154   fix the conflicts, while keeping the PR a straightforward list of commits. If
155   there are no conflicts, then there is no need to rebase anything.