From b183be0b717815704f20056b5294cb1225fb811d Mon Sep 17 00:00:00 2001 From: Tom Hughes Date: Sun, 17 Aug 2025 18:50:25 +0100 Subject: [PATCH] Cleanup trailing whitespace --- CONFIGURE.md | 10 +++++----- CONTRIBUTING.md | 12 ++++++------ INSTALL.md | 6 +++--- 3 files changed, 14 insertions(+), 14 deletions(-) diff --git a/CONFIGURE.md b/CONFIGURE.md index 4397cd368..b21b644cd 100644 --- a/CONFIGURE.md +++ b/CONFIGURE.md @@ -104,11 +104,11 @@ There are two built-in applications which communicate via the API, and therefore > [!TIP] > You can register both applications automatically by running the following rake task: -> +> > ```bash > bundle exec rails oauth:register_apps["My New User Name"] > ``` -> +> > This task registers the applications with the "My New User Name" user as the owner and saves their keys to `config/settings.local.yml`. When logged in, the owner should be able to see the apps on the OAuth 2 applications page. Alternatively you can register the applications manually, as described in the next section. @@ -191,17 +191,17 @@ tail -f log/development.log > [!TIP] > If your installation stops working for some reason: -> +> > - **Update gems:** Sometimes the bundle has been updated. Go to your `openstreetmap-website` directory and run: > ```bash > bundle install > ``` -> +> > - **Update Node.js modules:** If Node.js modules have been updated, run: > ```bash > bundle exec bin/yarn install > ``` -> +> > - **Run database migrations:** The OSM database schema is changed periodically. To keep up with improvements: > ```bash > bundle exec rails db:migrate diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1dcbeaa66..4302946b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,7 +62,7 @@ bundle exec erb_lint . --autocorrect > [!TIP] > You can also install hooks to have git run checks automatically when you commit using [overcommit](https://github.com/sds/overcommit) with: -> +> > ```bash > bundle exec overcommit --install > ``` @@ -98,7 +98,7 @@ The tests are automatically run on Pull Requests and other commits via github ac > [!TIP] > **System tests** use Selenium with Firefox for browser automation. On Ubuntu 24.04, if Firefox is installed via snap, you may need to override the Firefox binary path in `config/settings.local.yml`: -> +> > ```yaml > system_test_firefox_binary: /snap/firefox/current/usr/lib/firefox/firefox > ``` @@ -148,13 +148,13 @@ If your pull request is small, for example one or two commits each containing on > [!IMPORTANT] > 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 (for example 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. > [!TIP] > 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. @@ -170,9 +170,9 @@ The list of attributions on the /copyright page is managed by the [OSMF Licensin > [!IMPORTANT] > If you want to add another attribution, or make changes to the text of an existing attribution, please follow these steps: -> +> > * First, contact the LWG to discuss your proposed changes. > * If the LWG approves, please create a pull request with your proposed changes. > * Finally, please ask the LWG to formally approve the wording used in the pull request (by having an LWG member comment on the PR). -> +> > When we have formal confirmation from LWG, we can go ahead and merge the PR. diff --git a/INSTALL.md b/INSTALL.md index 1fd5c0d8f..76566a818 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -52,7 +52,7 @@ sudo npm install --global yarn > [!TIP] > On Ubuntu 24.04, you may need to start PostgreSQL: -> +> > ```bash > sudo systemctl start postgresql.service > ``` @@ -137,11 +137,11 @@ git clone https://github.com/openstreetmap/openstreetmap-website.git > [!TIP] > To clone only the most recent version (~23MB), instead use a 'shallow clone': -> +> > ```bash > git clone --depth=1 https://github.com/openstreetmap/openstreetmap-website.git > ``` -> +> > If you want to add in the full history later on, perhaps to run `git blame` or `git log`, run `git fetch --depth=1000000` ### Step 3: Install Application Dependencies -- 2.39.5