CONTRIBUTING.md

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