Request for better topic descriptions when filing tickets and pull requests

Hi everyone,

As the ansible project is getting rather exponential on user traffic lately, here’s a small request for everyone on GitHub usage.

When filing a ticket, whether a pull request or bug ticket or whatever, be sure the topic is really good and there’s also a really good description.

If something is about a module, say what module it is about. We get a lot of tickets like:

“add parameter xyz”

and this is hard to tell what the topic is about. This can be as simple as writing a better topic like:

“foo module: add new parameter xyz”

If it’s about ansible-pull, mention ansible-pull in the topic of the ticket. Don’t say “–help doesn’t list --option-foo” say, “ansible-pull --help doesn’t list --option-foo”.

Also, be more specific about errors if possible. Things like “foo module is broken” could be more informative if it was “foo module tracebacks when used with parameter xyz=2 on Arch Linux” or “foo module parameter xyz doesn’t appear to take effect”, etc.

This helps us find tickets easier, and also saves us more time for working on tickets versus organizing all the submissions we get, and editing the ticket names so we can remember what they are about.

I suspect a large majority of people on GitHub might not even be on this list, so this may be somewhat of an ineffective request, but we appreciate every bit of help we can get.

Thank you!

Probably best to put it in CONTRIBUTING.md - at least that’s what I read before doing anything.

Regards,

Phil

Yes, though bears repeating here - not everyone does read all of it.

We’ll also be tweaking the ansibot message.