The problem as I see it is not for the PR only since we merged commits that 
have the same issues.

Try  "git log" in a console and you will see that most commits have only a 
title without a commit message and context.
This may become a problem if in the future we want to understand why a commit 
was added without going back and studying the PR message.

To address this issue 
I tried to educate the authors so I started working on a commit guideline 
document that can help us align on how a commit title and message should look.
We can expand the same to the PR and educate ourselves so that we end with a 
clean description for each PR and commit 

Where should I publish this document?

Regards
Alin


-----Original Message-----
From: David Sidrane <david.sidr...@nscdg.com> 
Sent: den 17 september 2020 11:59
To: dev@nuttx.apache.org
Subject: PR's without adequate information

 PR's without adequate information

We are getting a slew of PR's without adequate information to consider merging 
them. Some of the Titles are incomplete or misleading.

I am also concerned about bloat and the loss of one of NuttX major
advantages: Scalability.

I have no doubt, there is a great deal of value being added but for* only some 
users**.* The changes are coming in with no way to disable them.

I would ask that PR have all the description sections filled in and provide 
justification.

I have seen this asked for repeatedly by several of the committers. We also 
have some excellent examples now or PRs that offer great context. Please model 
your submission after those PR.

Helping a reviewer gain the context, of Why, How, and What, will speed PR 
review and acceptance. Having to look at a PR and infer the intent waste of 
everyone's time.

David

Reply via email to