Replies: 4 comments 8 replies
-
Thank you for starting this discussion. This should be discussed because if we just went and did that migration, some people would be unpleasantly surprised by it. To the best of my understanding, I'll summarize each side's arguments. Here is the link to the website: https://moveit.ros.org/documentation/contributing/code/ Website
CONTRIBUTING.md
My PositionWe must find ways to reduce the difficulty of updating docs and contributing to MoveIt. Following standard conventions for open-source projects on GitHub is one way to move in that direction. Therefore, I am for migrating these docs from the website into a Tagging @henningkayser @v4hn @davetcoleman because I believe they will have opinions on this. |
Beta Was this translation helpful? Give feedback.
-
Thanks for your feedback @tylerjw @henningkayser and @v4hn. For now, shall I add the |
Beta Was this translation helpful? Give feedback.
-
Hi @tylerjw , I saw that this is still open issue. So wanted to know if I can help for the same. I see that there is a requirement for detailed documentation, which is also to be kept short and simple for new contributors. I am assuming this is the official reference document for new contributors. I'll try to note down some points which includes what changes I am planning to do. |
Beta Was this translation helpful? Give feedback.
-
Hello, I would like to work on this. I am new to Open source. It would be great to get some help. Thanks. In the issue #1922 the first task was to create a shorter first issue template . Do I need to work on that first?. As I understand from this discussion, the job is to incorporate necessary details from https://moveit.ros.org/documentation/contributing/pullrequests/ into CONTRIBUTING.md. |
Beta Was this translation helpful? Give feedback.
-
Introduction
As suggested in #1922, this discussion is broadly aimed at what the new
CONTRIBUTING.md
file should look like. Correct me if I'm wrong, but the consensus is to migrate contribution instructions to the file rather than having them on the website so that changes can be easily made and linked.Questions to be answered
CONTRIBUTION.md
? There will be separate sections within the file for 'good-first-issue', 'enhancing-docs', 'adding new features' etc. Or should these have their own.md
files?Please add anything else that I may be missing.
Beta Was this translation helpful? Give feedback.
All reactions