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

mmd notifications at github.com
Thu Jul 31 18:29:53 UTC 2025


@mmd-osm commented on this pull request.



> -```
+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:
+
+```bash
 bundle exec rubocop
 bundle exec rails eslint
 bundle exec erb_lint .
 ```

We should consider adding `bundle exec rails eslint:fix` to the list as well.
Eslint mentions a `--fix` option to fix any issues, but that doesn't work in our case (parameter is silently ignored).

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

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


More information about the rails-dev mailing list