From 62f41e6efa33c5494b6b2a009a4795972d77888b Mon Sep 17 00:00:00 2001 From: Anders Eknert Date: Tue, 4 Jun 2024 16:19:18 +0200 Subject: [PATCH] Rename development.md -> CONTRIBUTING.md This file name has a special meaning with GitHub, and they'll have it featured more prominently in certain location. See docs on that here: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors Signed-off-by: Anders Eknert --- .github/pull_request_template.md | 2 +- README.md | 2 +- docs/{development.md => CONTRIBUTING.md} | 0 3 files changed, 2 insertions(+), 2 deletions(-) rename docs/{development.md => CONTRIBUTING.md} (100%) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4c18554a..e3e0a811 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -2,7 +2,7 @@ Thank you for submitting a pull request to Regal! If you're new to contributing to the project, some tips and pointers are provided in the -development](https://github.com/StyraInc/regal/blob/main/docs/development.md) docs. If you find anything missing, or +contributing](https://github.com/StyraInc/regal/blob/main/docs/CONTRIBUTING.md) docs. If you find anything missing, or not made clear enough, that's a bug, and we'd appreciate hearing about it! If you want to ask questions before submitting your PR, or want to discuss Regal in general, please feel free to join diff --git a/README.md b/README.md index 29b9d80e..60e58ea6 100644 --- a/README.md +++ b/README.md @@ -640,7 +640,7 @@ See the [Editor Support](/docs/editor-support.md) page for information about Reg - [Custom Rules](/docs/custom-rules.md) describes how to develop your own linter rules - [Architecture](/docs/architecture.md) provides a high-level technical overview of how Regal works -- [Development](/docs/development.md) contains information about how to hack on Regal itself +- [Contributing](/docs/CONTRIBUTING.md) contains information about how to hack on Regal itself - [Go Integration](/docs/integration.md) describes how to integrate Regal in your Go application - [Rego Style Guide](/docs/rego-style-guide.md) contains notes on implementing the [Rego Style Guide](https://github.com/StyraInc/rego-style-guide) rules diff --git a/docs/development.md b/docs/CONTRIBUTING.md similarity index 100% rename from docs/development.md rename to docs/CONTRIBUTING.md