Dear @erget Yes, I agree with
> It's better to simply say in CONTRIBUTING something along the lines of "Use > an issue template that matches what you want to do" and then describe what to > do in the issue itself and thanks for implementing that approach. In order to follow the approach, the contributor needs guidance to decide which template to use - whether it's a defect, typo fix, github issue or enhancement. These categories should be related to the two categories in the rules documents (making changes, and correction of errors). I also agree that single- and multiple-paragraph changes are the same kind of enhancement and the guidance doesn't have to be separated like that. However, some of this advice is useful, and it would be a pity to lose it: > * If important to the issue, the problem text should be pasted in the body of > the issue and proposed fix included. > * A link to the line where the problem exists could also be included. > * If the modification is non-controversial, a pull request could be opened > simultaneously. > * Discussion of the proposal should take place in one issue. > * Final review should take place in the pull request and the issue closed > when the pull request is merged. > * Depending on the nature of the proposal, interested community members can > decide what the most effective tool is for development and review of > specification changes. > * Tools used for development of significant changes are up to those > contributing and reviewing it. > * Note that there is a rendered "rich-diff" view of a pull request that can > be helpful for review of large contributions. You may have put some of this in general guidance. If not, could the reminder belong in the template for an enhancement? Similarly, we currently have this guidance for a typo issue, which could go in its template: > * A pull request with the fix can be submitted directly. > * Contributors not familiar with github can submit issues for typos and > similar issues for others to fix. Thanks for considering this. Jonathan -- You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub: https://github.com/cf-convention/cf-conventions/issues/257#issuecomment-628753241 This list forwards relevant notifications from Github. It is distinct from [email protected], although if you do nothing, a subscription to the UCAR list will result in a subscription to this list. To unsubscribe from this list only, send a message to [email protected].
