search

solero / houdini

A Club Penguin private server written in Python 3
https://houdini.readthedocs.io/
MIT License
281 stars 54 forks source link

Suggestion - Create issue templates? #46

Closed ghost closed 4 years ago

ghost commented 4 years ago

Since there's a lot of things that could go wrong when setting up a CPPS using Houdini, I think it's a good practice to create an issue template for this repository. Something like specifying what version(s) you're running could be a start of this template.

ben-pearce commented 4 years ago

I think this is a great idea!

We don't really have a versioning system for Houdini set out yet, I guess because there's so many changes still happening that it doesn't make sense.

Perhaps we can use this thread to get some ideas of what a good template would be?

I'll give it a go first:

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Install Method Wand/Manual setup/Other (please specify)

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If this is a bug that happens in-game, post a screenshot with dev-tools open in your browser (F12 to open).

Server Info:

Additional context Add any other context about the problem here.

rsakeys commented 4 years ago

Might be helpful to also add:

Client Type: (vanilla or/and legacy)

ghost commented 4 years ago

This all sounds good and well, maybe creating such template is also applicable for pull requests?

ben-pearce commented 4 years ago

I created the new template and issued a pull request. Let me know what you think.

This all sounds good and well, maybe creating such template is also applicable for pull requests?

I'm not sure about this since pull requests can vary in purpose quite a bit. Do other projects do this? Is there something you had in mind for a template?

ghost commented 4 years ago

I believe Github provides support for creating pull request templates, I could be wrong. This should be somewhere in the repository settings, it's like a startup guide for setting up your repository.

ben-pearce commented 4 years ago

GitHub seems to only suggest templates for bug reports and feature requests.

ghost commented 4 years ago

I see, then you can ignore my mistake. Thanks for creating an issue template!