diff --git a/.github/workflows/welcome.yml b/.github/workflows/welcome.yml index 91fc5284..9935ede8 100644 --- a/.github/workflows/welcome.yml +++ b/.github/workflows/welcome.yml @@ -9,4 +9,6 @@ jobs: with: repo-token: ${{ secrets.GITHUB_TOKEN }} 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/). diff --git a/README.md b/README.md index fdca5792..f769d279 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ Documentation is hosted at https://golangci-lint.run. ## 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/). diff --git a/docs/src/config/sidebar.yml b/docs/src/config/sidebar.yml index 5519e301..5b9bece2 100644 --- a/docs/src/config/sidebar.yml +++ b/docs/src/config/sidebar.yml @@ -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 diff --git a/docs/src/docs/contributing/quick-start.mdx b/docs/src/docs/contributing/quick-start.mdx new file mode 100644 index 00000000..86534d2d --- /dev/null +++ b/docs/src/docs/contributing/quick-start.mdx @@ -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/) diff --git a/docs/src/docs/contributing/workflow.mdx b/docs/src/docs/contributing/workflow.mdx index 8e60e8a0..99c92bb5 100644 --- a/docs/src/docs/contributing/workflow.mdx +++ b/docs/src/docs/contributing/workflow.mdx @@ -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) - -