mirrors/diun
1
0
Fork 0
mirror of https://github.com/crazy-max/diun.git synced 2025-12-26 07:13:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update doc

Browse Source
This commit is contained in:
CrazyMax
2020-12-26 18:32:24 +01:00
parent 8da37307ca
commit 892fad6be1
2 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/CONTRIBUTING.md vendored
View File

@@ -27,5 +27,5 @@ Here are a few things you can do that will increase the likelihood of your pull
## Resources
* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
* [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
* [GitHub Help](https://help.github.com)
* [Using Pull Requests](https://docs.github.com/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
* [GitHub Help](https://docs.github.com)

16
docs/contributing.md
View File

@@ -2,7 +2,8 @@
Hi there! I'm thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license]({{ config.repo_url }}/blob/master/LICENSE).
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license)
to the public under the [project's open source license]({{ config.repo_url }}/blob/master/LICENSE).
## Submitting a pull request
@@ -10,10 +11,11 @@ Contributions to this project are [released](https://help.github.com/articles/gi
2. Configure and install the dependencies: `go mod download`
3. Create a new branch: `git checkout -b my-branch-name`
4. Make your changes
5. Test your code: `go test -covermode=atomic ./...`
6. Build with [GoReleaser](https://goreleaser.com/): `goreleaser release --skip-publish --skip-validate`
7. Push to your fork and [submit a pull request]({{ config.repo_url }}compare)
8. Pat your self on the back and wait for your pull request to be reviewed and merged.
5. Validate: `docker buildx bake validate`
6. Test your code: `docker buildx bake test`
7. Build the project: `docker buildx bake artifact-all image-all`
8. Push to your fork and [submit a pull request]({{ config.repo_url }}compare)
9. Pat your self on the back and wait for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
@@ -25,5 +27,5 @@ Here are a few things you can do that will increase the likelihood of your pull
## Resources
* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
* [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
* [GitHub Help](https://help.github.com)
* [Using Pull Requests](https://docs.github.com/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
* [GitHub Help](https://docs.github.com)