scratchfoundation/golangci-lint
1
0
Fork 0
mirror of https://github.com/scratchfoundation/golangci-lint.git synced 2025-08-28 22:28:43 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add contributing quick start

Browse source
This commit is contained in:
Denis Isaev 2020-05-17 10:49:11 +03:00
parent b49d2df623
commit 84892fc15f
5 changed files with 16 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/src/config/sidebar.yml
View file

@ -32,6 +32,8 @@
link: "https://github.com/golangci/golangci-lint"
- label: Contributing
items:
- label: Quick Start
link: /contributing/quick-start/
- label: Workflow
link: /contributing/workflow/
- label: Architecture

10
docs/src/docs/contributing/quick-start.mdx Normal file
View 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/)

10
docs/src/docs/contributing/workflow.mdx
View file

@ -46,13 +46,3 @@ First, please, accept [CLA](https://gist.github.com/jirfag/26a39fd375da84b2d5ad4
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).
## Credits
### Contributors
Thank you to all the people who have already contributed to `golangci-lint`!
[![golangci-lint contributors](https://contributors-img.web.app/image?repo=golangci/golangci-lint)](https://github.com/golangci/golangci-lint/graphs/contributors)
<!-- TODO: use `allcontributors` -->