Skip to content

docs: modify CONTRIBUTING.md #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FilipFan merged 1 commit into from
Oct 19, 2025
Merged

docs: modify CONTRIBUTING.md #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
The repository is not currently ready for code contributions.
(Stay tuned...)
# Contributing

Thank you for considering to contribute to `CarToolForge`!

## Found an Issue?

You can create a [new issue](https://github.com/autoharness/CarToolForge/issues/new) if you find a bug in the source code or a mistake in the documentation. Even better you can submit a Pull Request with a fix.

## Contributing Code

This repo uses Github pull requests (PRs) to stage and review code before merging it into the `main` branch. See the [Github docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) for basics.

Before submitting your pull request, please run the local checks to ensure all tests pass. This helps speed up the review process.

```
./gradlew :buildSrc:spotlessCheck
./gradlew :buildSrc:test
./gradlew clean build
```