## Coding style
-When writing code it is generally a good idea to try and match your
-formatting to that of any existing code in the same file, or to other
-similar files if you are writing new code. Consistency of layout is
-far more important than the layout itself as it makes reading code
-much easier.
+We use [Rubocop](https://github.com/rubocop-hq/rubocop) (for ruby files)
+and [ERB Lint](https://github.com/Shopify/erb-lint) (for erb templates)
+to help maintain consistency in our code. You can run these utilities during
+development to check that your code matches our guidelines:
-One golden rule of formatting -- please don't use tabs in your code
-as they will cause the file to be formatted differently for different
-people depending on how they have their editor configured.
+```
+bundle exec rubocop
+bundle exec rails eslint
+bundle exec erblint .
+```
## Testing
Having a good suite of tests is very important to the stability and
-maintainability of any code base. The tests in the Rails port code are
+maintainability of any code base. The tests in the `openstreetmap-website` code are
by no means complete, but they are extensive, and must continue to be
so with any new functionality which is written. Tests are also useful
in giving others confidence in the code you've written, and can
greatly speed up the process of merging in new code.
-When hacking, you should:
+When contributing, you should:
* Write new tests to cover the new functionality you've added.
* Where appropriate, modify existing tests to reflect new or changed
You can run the existing test suite with:
```
-bundle exec rake test
+bundle exec rails test:all
```
You can view test coverage statistics by browsing the `coverage` directory.
-The tests are automatically run on Pull Requests and other commits with the
-results shown on [Travis CI](https://travis-ci.org/openstreetmap/openstreetmap-website).
+The tests are automatically run on Pull Requests and other commits via github
+actions. The results shown are within the PR display on github.
+
+## Static Analysis
+
+We also perform static analysis of our code. You can run the analysis yourself with:
+
+```
+bundle exec brakeman -q
+```
## Comments
developers to read the code and satisfy themselves that it's doing the
right thing.
-When hacking, you should:
+When contributing, you should:
-* Comment your code - don't go overboard, but explain the bits which
+* Comment your code where necessary - explain the bits which
might be difficult to understand what the code does, why it does it
and why it should be the way it is.
* Check existing comments to ensure that they are not misleading.
-## Code Documentation
+## i18n
-To generate the HTML documentation of the API/rails code, run the command
+If you make a change that involve the locale files (in `config/locales`) then please
+only submit changes to the `en.yml` file. The other files are updated via
+[Translatewiki](https://translatewiki.net/wiki/Translating:OpenStreetMap) and should
+not be included in your pull request.
-```
-rake doc:app
-```
+### Nominatim prefixes
+
+I18n keys under the `geocoder.search_osm_nominatim` keyspace are managed by the
+Nominatim maintainers. From time to time they run stats over the Nominatim
+database, and update the list of available keys manually.
+
+Adding or removing keys to this list is therefore discouraged, but contributions
+to the descriptive texts are welcome.
## Committing
-When you submit patches, the project maintainer has to read them and
+When you submit your changes, the project maintainers have to read them and
understand them. This is difficult enough at the best of times, and
-misunderstanding patches can lead to them being more difficult to
-merge. To help with this, when submitting you should:
+misunderstanding commits can lead to them being more difficult to
+merge. To help with this, when committing you should:
-* Split up large patches into smaller units of functionality.
+* Split up large commits into smaller units of functionality.
* Keep your commit messages relevant to the changes in each individual
-unit.
+commit.
When writing commit messages please try and stick to the same style as
other commits, namely:
For simple commits the one line summary is often enough and the body
of the commit message can be left out.
-## Sending the patches
+## Pull Requests
If you have forked on GitHub then the best way to submit your patches is to
push your changes back to GitHub and then send a "pull request" on GitHub.
-Otherwise you should either push your changes to a publicly visible git repository
-and send the details to the [rails-dev](https://lists.openstreetmap.org/listinfo/rails-dev)
-list or generate patches with `git format-patch` and send them to the
-[rails-dev](https://lists.openstreetmap.org/listinfo/rails-dev) list.
+If your pull request is small, for example one or two commits each containing
+only a few lines of code, then it is easy for the maintainers to review.
+
+If you are creating a larger pull request, then please help the maintainers
+with making the reviews as straightforward as possible:
+
+* The smaller the PR, the easier it is to review. In particular if a PR is too
+ large to review in one sitting, or if changes are requested, then the
+ maintainer needs to repeatedly re-read code that has already been considered.
+* The commit history is important. This is a large codebase, developed over many
+ years by many developers. We frequently need to read the commit history (e.g.
+ using `git blame`) to figure out what is going on. So small, understandable,
+ and relevant commits are important for other developers looking back at your
+ work in future.
+
+If you are creating a large pull request then please:
+
+* Consider splitting your pull request into multiple PRs. If part of your work
+ can be considered standalone, or is a foundation for the rest of your work,
+ please submit it separately first.
+* Avoid including "fixup" commits. If you have added a fixup commit (for example
+ to fix a rubocop warning, or because you changed your own new code) please
+ combine the fixup commit into the commit that introduced the problem.
+ `git rebase -i` is very useful for this.
+* Avoid including "merge" commits. If your PR can no longer be merged cleanly
+ (for example, an unrelated change to Gemfile.lock on master now conflicts with
+ your PR) then please rebase your PR onto the latest master. This allows you to
+ fix the conflicts, while keeping the PR a straightforward list of commits. If
+ there are no conflicts, then there is no need to rebase anything.
projects / rails.git / blobdiff