acassis commented on issue #18375: URL: https://github.com/apache/nuttx/issues/18375#issuecomment-3876945184
> Hi everyone, if I am not mistaken, this information is used in two different contexts. > > * https://github.com/apache/nuttx/blob/master/CONTRIBUTING.md > Very concise because it is present as a link when opening a new PR, see template > https://github.com/apache/nuttx/blob/master/.github/PULL_REQUEST_TEMPLATE.md > [202503 Apache NuttX RTOS Contributing Guidelines update. #15950](https://github.com/apache/nuttx/pull/15950) > > * https://nuttx.apache.org/docs/latest/contributing/index.html > Much more detailed, it is part of the documentation. > > > Therefore, in my opinion, they should remain separate. But that is the question we need to ask: why to have a concise and a detailed Contributing guide? Seems like someone reading the concise guide normally will make mistakes when submitting the PRs. Maybe we can merge it is a way that it has the overview of each steps and a deeper explanation (case someone face some issue using only the overview). In most the case a contributor will end-up reading both, because some steps are missing in the simplified version. Just my 2 cents. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
