diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89f042b2..7e4f604f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,15 +4,17 @@ We 💙 our community but **this repository does not accept unsolicited pull req Please read this [community blog post][guidelines] for details. -If you want to contribute or have a bug to report, please open a topic [in the forum][zig-forum] first, so we can discuss things before we do things. +## How to contribute -Once you have a go-ahead from one of the maintainers, a pull request must adhere to [Exercism's style guide][style]. +1. Open a topic [in the forum][zig-forum] — for bug reports, feature ideas, or questions about the track, including anything you'd otherwise file as an issue. +1. Discuss the proposal with the maintainers. +1. Once you have a go-ahead, submit a pull request that adheres to [Exercism's style guide][style]. If the PR touches an existing exercise, please also consider [this warning][unnecessary-test-runs] in the documentation for [building tracks][building-tracks]. ## Running Tests -Exercises can be tested against the locally installed Zig compliler using +Exercises can be tested against the locally installed Zig compiler using ```bash bin/run-tests diff --git a/README.md b/README.md index 817cfc84..bb399947 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # Exercism Zig Track -Exercism exercises in Zig. +Exercism exercises in [Zig](https://ziglang.org/). + +This repository holds the practice exercises and configuration for the [Zig track][track] on Exercism. + +## Contributing + +If you'd like to contribute or report a bug, please start a topic in the [Zig forum][zig-forum] first, so the idea can be discussed before any code is written. +This follows Exercism's track-wide [contribution guidelines][guidelines]. + +See [CONTRIBUTING.md](./CONTRIBUTING.md) for the full contributor guide, including how to run the tests locally. + +[track]: https://exercism.org/tracks/zig +[zig-forum]: https://forum.exercism.org/c/programming/zig/199 +[guidelines]: https://exercism.org/blog/contribution-guidelines-nov-2023