VictoriaMetrics/.github/pull_request_template.md

### Describe Your Changes

Please provide a brief description of the changes you made. Be as specific as possible to help others understand the purpose and impact of your modifications.

### Checklist

The following checks are **mandatory**:

- [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/).
[docs][github] Update contributing information (#6040) * add pull request template Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * update text Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * update text Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * Update .github/PULL_REQUEST_TEMPLATE/pull_request_template.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * Update .github/PULL_REQUEST_TEMPLATE/pull_request_template.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * update messaging add example Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * docs/contributing: add info about mandatory requirements before sending a PR Added the following info: - commits signing / sign-off - how to run tests / linting with make commands Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> --------- Signed-off-by: Artem Navoiev <tenmozes@gmail.com> Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Artem Navoiev <tenmozes@gmail.com> Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> 2024-04-04 01:01:44 +02:00			`### Describe Your Changes`

			`Please provide a brief description of the changes you made. Be as specific as possible to help others understand the purpose and impact of your modifications.`

			`### Checklist`

Move CONTRIBUTING.md to docs/ It is better from visibility PoV if the CONTRIBUTING.md file is visible at https://docs.victoriametrics.com/contributing/ . This page can be indexed by search engines and searched by our users later. It is also easier to provide a link to this page now comparing to the old link, which is much harder to remember: https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/CONTRIBUTING.md While at it, syncrhonize docs/CONTRIBUTING.md with .github/PULL_REQUEST_TEMPLATE/pull_request_template.md , so they do not contain duplicate information, which can be outdated over time. Now all the relevant information is located at docs/CONTRIBUTING.md, while .github/PULL_REQUEST_TEMPLATE/pull_request_template.md refers this doc. This is a follow-up for c006db1798ca6343aa9354e470d16df84cb616ec Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6040 2024-04-20 23:06:37 +02:00			`The following checks are mandatory:`
[docs][github] Update contributing information (#6040) * add pull request template Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * update text Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * update text Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * Update .github/PULL_REQUEST_TEMPLATE/pull_request_template.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * Update .github/PULL_REQUEST_TEMPLATE/pull_request_template.md Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> * update messaging add example Signed-off-by: Artem Navoiev <tenmozes@gmail.com> * docs/contributing: add info about mandatory requirements before sending a PR Added the following info: - commits signing / sign-off - how to run tests / linting with make commands Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> --------- Signed-off-by: Artem Navoiev <tenmozes@gmail.com> Signed-off-by: Zakhar Bessarab <z.bessarab@victoriametrics.com> Co-authored-by: Artem Navoiev <tenmozes@gmail.com> Co-authored-by: Roman Khavronenko <roman@victoriametrics.com> 2024-04-04 01:01:44 +02:00
Move CONTRIBUTING.md to docs/ It is better from visibility PoV if the CONTRIBUTING.md file is visible at https://docs.victoriametrics.com/contributing/ . This page can be indexed by search engines and searched by our users later. It is also easier to provide a link to this page now comparing to the old link, which is much harder to remember: https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/CONTRIBUTING.md While at it, syncrhonize docs/CONTRIBUTING.md with .github/PULL_REQUEST_TEMPLATE/pull_request_template.md , so they do not contain duplicate information, which can be outdated over time. Now all the relevant information is located at docs/CONTRIBUTING.md, while .github/PULL_REQUEST_TEMPLATE/pull_request_template.md refers this doc. This is a follow-up for c006db1798ca6343aa9354e470d16df84cb616ec Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6040 2024-04-20 23:06:37 +02:00			`- [ ] My change adheres [VictoriaMetrics contributing guidelines](https://docs.victoriametrics.com/contributing/).`