Skip to content

Commit d7f649f

Browse files
committed
docs: update CONTRIBUTING.md with Makefile commands and new workflow name
1 parent 6396118 commit d7f649f

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,10 @@ If you want to contribute code or documentation to the project, please follow th
2828
3. Follow the [C++ Core Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines) for writing idiomatic and maintainable code.
2929
4. Add tests for your code if applicable, and make sure all tests pass.
3030
5. Ensure your code compiles without warnings using `-Wall -Wextra -Wpedantic`.
31-
6. Build and test your changes:
31+
6. Build and test your changes using the Makefile:
3232
```bash
33-
mkdir build && cd build
34-
cmake -DCMAKE_BUILD_TYPE=Debug ..
35-
make -j$(nproc)
33+
make build
34+
make test
3635
```
3736
7. Update the documentation if necessary, and make sure it is consistent with the code.
3837
8. Open a pull request with a descriptive title and a summary of your changes. Link any relevant issues in the description.
@@ -45,7 +44,7 @@ This project uses GitHub Actions for continuous integration and release automati
4544

4645
### Workflows
4746

48-
- **CI** (`.github/workflows/ci.yml`): Runs on every push to `main` and pull requests. It builds the project on Ubuntu and macOS to ensure code compiles correctly.
47+
- **Test** (`.github/workflows/test.yml`): Runs on every push to `main` and pull requests. It builds the project and runs tests on Ubuntu.
4948

5049
- **Build and Release** (`.github/workflows/release.yml`): Creates GitHub Releases automatically when you push a version tag (e.g., `v1.0.0`). It builds and attaches binaries for both Linux and macOS.
5150

0 commit comments

Comments
 (0)