You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Add link to pages in contribution guide (google#983)
* docs: Update contributing.md
* docs: add link to pages in contrubition
* docs: move link to docs
* docs: changed test+cov command
---------
Co-authored-by: Anton Golub <antongolub@antongolub.com>
We'd love to accept your patches and contributions to this project. There are
4
-
just a few small guidelines you need to follow.
3
+
zx is a fully [open-source project](https://github.com/google/zx), which is developing by the community for the community.
4
+
We welcome contributions of any kind, including but not limited to:
5
+
* Bug reports
6
+
* Feature requests
7
+
* Code contributions
8
+
* Documentation improvements
9
+
* Discussions
10
+
11
+
https://google.github.io/zx/contribution
12
+
13
+
## Community Guidelines
14
+
15
+
This project follows [Google's Open Source Community Guidelines](https://opensource.google/conduct/).
16
+
In short: all contributors are treated with respect and fairness.
5
17
6
18
## Contributor License Agreement
7
19
@@ -15,14 +27,28 @@ You generally only need to submit a CLA once, so if you've already submitted one
15
27
(even if it was for a different project), you probably don't need to do it
16
28
again.
17
29
30
+
## How to Contribute
31
+
Before proposing changes, look for similar ones in the project's [issues](https://github.com/google/zx/issues) and [pull requests](https://github.com/google/zx/pulls). If you can't decide, create a new [discussion](https://github.com/google/zx/discussions) topic, and we will help you figure it out. When ready to move on:
32
+
* Prepare your development environment.
33
+
* Ensure you have Node.js 20+ installed.
34
+
* Bash is essential for running zx scripts. Linux and macOS users usually have it installed by default. Consider using [Windows Subsystem for Linux](https://docs.microsoft.com/en-us/windows/wsl/install) or [Git Bash](https://git-scm.com/downloads) if you are on Windows.
* If you are adding a new feature, please include additional tests. The coverage threshold is 98%.
39
+
* Create a [conventional-commits](https://www.conventionalcommits.org/en/v1.0.0/) compliant messages.
40
+
* Ensure that everything is working:
41
+
*`npm run fmt` to format your code.
42
+
*`npm run test:coverage` to run the tests.
43
+
* Push the changes to your fork.
44
+
* Create a pull request.
45
+
* Describe your changes in detail.
46
+
* Reference any related issues if applicable.
47
+
18
48
## Code Reviews
19
49
20
-
All submissions, including submissions by project members, require review. We
21
-
use GitHub pull requests for this purpose. Consult
22
-
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
23
-
information on using pull requests.
50
+
All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
24
51
25
-
## Community Guidelines
52
+
## License
26
53
27
-
This project follows [Google's Open Source Community
28
-
Guidelines](https://opensource.google/conduct/).
54
+
The project is licensed under the [Apache-2.0](https://github.com/google/zx?tab=Apache-2.0-1-ov-file#readme)
0 commit comments