docs: add contributing quick start
This commit is contained in:
parent
b49d2df623
commit
84892fc15f
4
.github/workflows/welcome.yml
vendored
4
.github/workflows/welcome.yml
vendored
@ -9,4 +9,6 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
issue-message: "Hey, thank you for opening your first Issue ! 🙂"
|
issue-message: "Hey, thank you for opening your first Issue ! 🙂"
|
||||||
pr-message: "Hey, thank you for opening your first Pull Request !"
|
pr-message: |
|
||||||
|
Hey, thank you for opening your first Pull Request !
|
||||||
|
If you would like to contribute we have a [guide for contributors](https://golangci-lint.run/contributing/quick-start/).
|
||||||
|
@ -28,7 +28,7 @@ Documentation is hosted at https://golangci-lint.run.
|
|||||||
|
|
||||||
## Contributors
|
## Contributors
|
||||||
|
|
||||||
This project exists thanks to all the people who contribute. [How to contribute](https://golangci-lint.run/contributing/workflow/).
|
This project exists thanks to all the people who contribute. [How to contribute](https://golangci-lint.run/contributing/quick-start/).
|
||||||
|
|
||||||
<a href="https://github.com/golangci/golangci-lint/graphs/contributors">
|
<a href="https://github.com/golangci/golangci-lint/graphs/contributors">
|
||||||
<img src="https://contributors-img.web.app/image?repo=golangci/golangci-lint" />
|
<img src="https://contributors-img.web.app/image?repo=golangci/golangci-lint" />
|
||||||
|
@ -32,6 +32,8 @@
|
|||||||
link: "https://github.com/golangci/golangci-lint"
|
link: "https://github.com/golangci/golangci-lint"
|
||||||
- label: Contributing
|
- label: Contributing
|
||||||
items:
|
items:
|
||||||
|
- label: Quick Start
|
||||||
|
link: /contributing/quick-start/
|
||||||
- label: Workflow
|
- label: Workflow
|
||||||
link: /contributing/workflow/
|
link: /contributing/workflow/
|
||||||
- label: Architecture
|
- label: Architecture
|
||||||
|
10
docs/src/docs/contributing/quick-start.mdx
Normal file
10
docs/src/docs/contributing/quick-start.mdx
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
title: Contributing Quick Start
|
||||||
|
---
|
||||||
|
|
||||||
|
1. [Contributing workflow](/contributing/workflow/): about our workflow and environment setup.
|
||||||
|
2. [Architecture of golangci-lint](/contributing/architecture/)
|
||||||
|
3. [How to add new linters](/contributing/new-linters/)
|
||||||
|
4. [Debugging golangci-lint](/contributing/debug/)
|
||||||
|
5. [Contributing FAQ](/contributing/faq/)
|
||||||
|
6. [Contributing to the website](/contributing/website/)
|
@ -46,13 +46,3 @@ First, please, accept [CLA](https://gist.github.com/jirfag/26a39fd375da84b2d5ad4
|
|||||||
make a comment on the pull request about it.
|
make a comment on the pull request about it.
|
||||||
|
|
||||||
Also, we run a few checks in CI by using GitHub actions, you can see them [here](https://github.com/golangci/golangci-lint/blob/master/.github/workflows/pr.yml).
|
Also, we run a few checks in CI by using GitHub actions, you can see them [here](https://github.com/golangci/golangci-lint/blob/master/.github/workflows/pr.yml).
|
||||||
|
|
||||||
## Credits
|
|
||||||
|
|
||||||
### Contributors
|
|
||||||
|
|
||||||
Thank you to all the people who have already contributed to `golangci-lint`!
|
|
||||||
|
|
||||||
[](https://github.com/golangci/golangci-lint/graphs/contributors)
|
|
||||||
|
|
||||||
<!-- TODO: use `allcontributors` -->
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user