On Thu, Dec 26, 2019 at 9:51 AM Anthony Merlino <anth...@vergeaero.com> wrote: > I have started a CONTRIBUTORS.md file in a personal fork of incubator-nuttx: > > https://github.com/antmerlino/incubator-nuttx/blob/antmerlino-contributors-md/CONTRIBUTORS.md > > For those not familiar, CONTRIBUTORS.md is a common file found in many > other open source projects that tells interested parties how to contribute > to the project. It is essentially the workflow document. > > I have asked David to show me the ropes of suggesting changes in the Github > UI. The suggested changes land as separate commits, which allows us to > track changes and authorship while developing this document. You can also > pull the repo, make changes, and open a PR against the branch too, if you > don't want to work in Github. Of course we can squash it all together at > the end when/if we merge it in. This is a much more collaborative way of > working. We can make comments in context, see what others are suggesting, > and integrate that feedback quickly into the deliverable. Otherwise we are > waiting for some poor soul to do 90% of the work themselves and then do the > extra 10% work of integrating people's feedback from the emails. That's not > a good collaboration method. > > If others are keen on this idea, I propose that we move this branch and PR > from my personal fork, to the incubator-nuttx repository, collaborate on > the PR, and land when we are all happy. Based on the discussion here, I > will call a vote to move the PR and branch.
Hello Anthony, Thank you for taking initiative here. I like the idea of a CONTRIBUTORS.md file. Here is a great opportunity for our fledgling Apache NuttX Podling to practice working together: I suggest to put CONTRIBUTORS.md into the official Apache NuttX repo right now. Let's move the text that is in the Confluence workflow proposal right now and put it into CONTRIBUTORS.md. Already some work was done so let's not throw it away. Once it is in CONTRIBUTORS.md, anyone can make a git clone, add/edit some text to CONTRIBUTORS.md, and send a patch or a pull request. The community will discuss/review it. If there is consensus that the text is a good addition to CONTRIBUTORS.md, a committer will commit it and we will proceed from there. Advantages: (1) We will practice our workflow while we write it. (2) It will be The Apache Way. Nathan
