[openstreetmap/openstreetmap-website] Restructure core developer docs (PR #6111)

[Tom Hughes]

@tomhughes commented on this pull request.



> -  * 'Upload GPS traces'
-  * 'Modify notes'
-* On the next page, copy the "Client ID"
-* Edit config/settings.local.yml in your rails tree
-* Add the "id_application" configuration with the "Client ID" as the value
-* Restart your rails server
-
-An example excerpt from settings.local.yml:
-
-```yaml
-# Default editor
-default_editor: "id"
-# OAuth 2 Client ID for iD
-id_application: "Snv…OA0"
-```
+There are two built-in applications which communicate via the API, and therefore need to be registered as OAuth 2 applications. These are:

The new documentation for @AntonKhorev's rake task for setting up the oauth keys needs to be preserved here...

>  
-Rails has its own log.  To inspect the log, do this:
+> [!TIP]
+> If your installation stops working for some reason:
+> 
+> - **Update gem dependencies:** Sometimes gem dependencies change. Go to your `openstreetmap-website` directory and run:

I'd just say `gems` rather than `gem dependencies` as it's not really about dependencies changing, just that the bundle as a whole has been updated.

We should probably also have a bullet point for running `bundle exec bin/yarn install` to update node modules.

>  
-```
+1. **Find an Issue**: Browse our [issues](https://github.com/openstreetmap/openstreetmap-website/issues) or identify a bug/feature you'd like to work on
+2. **Fork & Clone**: Fork the repository and clone it to your local machine
+3. **Set Up**: Follow the [installation guide](INSTALL.md) to set up your development environment
+4. **Develop**: Make your changes following our [code quality guidelines](#code-quality-guidelines)
+5. **Test**: Write tests for your changes and ensure all existing tests pass
+6. **Commit**: Write clear commit messages following our [guidelines](#committing)
+7. **Submit a Pull Request**: Create a pull request with a clear description of your changes
+
+## Code Quality Guidelines
+
+### Coding Style
+
+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:

This should probably mention eslint as well given it's in the list of commands to run!

-- 
Reply to this email directly or view it on GitHub:
https://github.com/openstreetmap/openstreetmap-website/pull/6111#pullrequestreview-3076437817
You are receiving this because you are subscribed to this thread.

Message ID: <openstreetmap/openstreetmap-website/pull/6111/review/3076437817 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstreetmap.org/pipermail/rails-dev/attachments/20250731/485f5b4f/attachment.htm>