generated from tf-libsonnet/provider-libsonnet-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Flesh out README with initial usage docs (#9)
Signed-off-by: Yoriyasu Yano <430092+yorinasub17@users.noreply.github.com>
- Loading branch information
1 parent
6acbdac
commit 5bd774b
Showing
2 changed files
with
113 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# How to contribute to tf.libsonnet | ||
|
||
**Filing issues** | ||
|
||
- **Report bugs and feature requests on the libgenerator repository as GitHub issues**. This is an autogenerated | ||
library, which means that any bugs and feature requests need to be reported on the [libgenerator | ||
project](https://github.com/tf-libsonnet/libgenerator) which is responsible for generating this repository. If you | ||
found an issue, you can open a new issue from [this | ||
link](https://github.com/tf-libsonnet/libgenerator/issues/new/choose). | ||
- **Do not open a GitHub issue if you are reporting a security vulnerability with the tf.libsonnet project**. Instead, | ||
refer to our [security policy](/SECURITY.md). | ||
|
||
|
||
**Contributing a change** | ||
|
||
- **This is an autogenerated library**. This means that all contributions will not be merged until the changes can be | ||
autogenerated from the generator. You may still open a Pull Request with a suggested change, especially if it helps | ||
augment an issue description by providing an example of what should be generated. | ||
- **All commits must be signed off to adhere to the Developer Certificate of Origin (DCO)**. If you are contributing a | ||
change to `libgenerator`, note that the `tf.libsonnet` org requires all contributors to sign off on [the | ||
DCO](https://developercertificate.org/). You can do this with the `-s` flag when making commits with `git commit`. | ||
- If you forgot to sign off on any commits in a Pull Request, you can amend the offending commit with `git commit -s | ||
--amend`. | ||
- **All commits must be signed**. The `tf.libsonnet` org requires all contributors to [sign their | ||
commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). If you do | ||
not wish to maintain a set of private keys on your account, you can also use the | ||
[sigstore/gitsign](https://github.com/sigstore/gitsign) project for keyless signing with your GitHub account. | ||
|
||
**Support** | ||
|
||
- Ask any question about how to use the `tf.libsonnet` libraries in the [Organization | ||
GitHub Discussion](https://github.com/orgs/tf-libsonnet/discussions). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters