Hi Jonathan, I agree that this guidance is useful and think it's best to put it in the appropriate issue templates.
> * 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. I've included both of these in the "Defect", template. > * If the modification is non-controversial, a pull request could be opened > simultaneously. I've included this in the "Enhancement". > * Discussion of the proposal should take place in one issue. This is noted in [CONTRIBUTING](https://github.com/cf-convention/cf-conventions/pull/256/files#diff-6a3371457528722a734f3c51d9238c13R22). > * Final review should take place in the pull request and the issue closed > when the pull request is merged. I believe [CONTRIBUTING](https://github.com/cf-convention/cf-conventions/pull/256/files#diff-6a3371457528722a734f3c51d9238c13R44) also sufficiently covers this in its final section. > * 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. I would consider this implicit based on CONTRIBUTING lines 14-18: > These contribution guidelines are designed to make it easy to contribute to > the > CF Conventions and are tailored to the platform where they are hosted, GitHub. > They are intended to support your work and not to constrict you; if at any > time > you find them difficult to follow, ask for help. > Your contribution is valuable and the community will be happy to give a hand. > What do you think? Cheers, Daniel -- 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-629158171 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].
