search

LeastAuthority / txkube

A Twisted-based Kubernetes client.
MIT License
12 stars 6 forks source link

Not all contributors know they should create an issue before proposing a code change #175

Closed exarkun closed 6 years ago

exarkun commented 6 years ago

txkube development process involves filing an issue which describes something that's not desirable about txkube. This might be a defect in some existing functionality (a "bug") or the complete lack of some area of functionality txkube hasn't previously targeted (a "feature").

Another part of the txkube development process is pre-merge code review. It's important to have issues that describe a user desire so that code review can include an assessment of whether that desire is being satisfied by the change or not. It's not enough to propose some changes and say "see, it's different now". An issue describing the desire also creates a durable location for discussion about that desire (as opposed to a pull request which is scoped to a specific set of code changes). And an issue also plays nicely with towncrier.

There's no reason to expect any random contributor will know all this, though. So we need to communicate it to them.

exarkun commented 6 years ago

A GitHub pull request template seems like the conventional way to do this. Put the information in the template and it will automatically appear in the pull request description text area when a new pull request is created.