From 0085c781ffb18ff94d4b0ed4952da5f1f5269612 Mon Sep 17 00:00:00 2001 From: zfan5 Date: Sun, 19 Oct 2025 20:10:00 +0800 Subject: [PATCH] docs: modify CONTRIBUTING.md --- CONTRIBUTING.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19c0f3b..c043199 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,2 +1,19 @@ -The repository is not currently ready for code contributions. -(Stay tuned...) \ No newline at end of file +# 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 +```