From 2c5091415e48fe8264c5e7d88d292aee6bab8011 Mon Sep 17 00:00:00 2001 From: Tomasz 'CeDeROM' CEDRO Date: Fri, 11 Oct 2024 20:55:49 +0200 Subject: [PATCH] Contributing and PR template fix. * Fix CONTRIBUTING.md github link reference. * Full URL is provided to avoid relative/fork reference issues. * Minor update on full contributing documentation. Signed-off-by: Tomasz 'CeDeROM' CEDRO --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 9 ++------- 2 files changed, 3 insertions(+), 8 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0c929e8591..d95cfcec56 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,4 @@ -*Note: Please adhere to [Contributing Guidelines](../CONTRIBUTING.md).* +*Note: Please adhere to [Contributing Guidelines](https://github.com/apache/nuttx/blob/master/CONTRIBUTING.md).* ## Summary diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0643bdf42e..b14b339bb3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,7 @@ Hi! Thank you for your interest in contributing to Apache NuttX RTOS :-) To help us successfully review your contribution, it is very important that you follow these guidelines. +If you need more information please read the [Full Contributing Documentation](https://nuttx.apache.org/docs/latest/contributing/index.html). ### Coding Standard @@ -81,12 +82,6 @@ important that you follow these guidelines. ## References - -### Documentation - -For general notes on contributing to Apache NuttX continue reading [here](https://nuttx.apache.org/docs/latest/contributing/index.html). - - ### Example Pull Request Report #### Summary @@ -133,6 +128,6 @@ For general notes on contributing to Apache NuttX continue reading [here](https: * [ ] This PR introduces only one functional change. * [ ] I have updated all required description fields above. - * [ ] My PR adheres to [CONTRIBUTING](../CONTRIBUTING.md) guidelines (git commit title and message, coding standard, etc). + * [ ] My PR adheres to Contributing [Guidelines](https://github.com/apache/nuttx/blob/master/CONTRIBUTING.md) and [Documentation](https://nuttx.apache.org/docs/latest/contributing/index.html) (git commit title and message, coding standard, etc). * [ ] My PR is still work in progress (not ready for review). * [ ] My PR is ready for review and can be safely merged into a codebase.