Skip to content
New issue

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

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

Already on GitHub? # to your account

Docs: Add link to pages in contribution guide #983

Merged
merged 8 commits into from
Dec 15, 2024

Conversation

LifeforDream
Copy link
Contributor

@LifeforDream LifeforDream commented Dec 14, 2024

Fixes #982

  • Tests pass
  • Appropriate changes to README are included in PR

Copy link

google-cla bot commented Dec 14, 2024

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@LifeforDream LifeforDream changed the title Add link to pages in contribution guide Docs: Add link to pages in contribution guide Dec 14, 2024
just a few small guidelines you need to follow.
## Disclaimer

This is a snapshot of a contribution guide.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# Contribution Guide

zx is a fully [open-source project](https://github.com/google/zx), which is developing by the community for the community. 
We welcome contributions of any kind, including but not limited to:
* Bug reports
* Feature requests
* Code contributions
* Documentation improvements
* Discussions

https://google.github.io/zx/contribution

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved the link, removed the disclaimer

* Create a [conventional-commits](https://www.conventionalcommits.org/en/v1.0.0/) compliant messages.
* Ensure that everything is working:
* `npm run fmt` to format your code.
* `npm run cov` to run the tests.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

npm run cov > npm test

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

npm run cov not exist. Maybe npm run test:coverage ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
Changed that

@antongolub antongolub added the ossln24 OSS Library Night 2024 label Dec 15, 2024
Copy link
Collaborator

@antongolub antongolub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm. Thanks for the contribution!

@antongolub antongolub merged commit 9d28e65 into google:main Dec 15, 2024
21 checks passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
ossln24 OSS Library Night 2024
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Create contribution guide
3 participants