Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added: templates #1

Closed
wants to merge 1 commit into from
Closed

Added: templates #1

wants to merge 1 commit into from

Conversation

GoliathLabs
Copy link
Member

@GoliathLabs GoliathLabs commented Mar 27, 2022

I've added PR & Issue templates as well as a README file

Closes freifunkMUC/wg-access-server#74

Copy link
Member

@DasSkelett DasSkelett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few notes. Some things are wg-access-server specific, not sure how to handle those.

Comment on lines +37 to +39
* Browser Name and version:
* Operating System and version (desktop or mobile):
* Link to your project:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least for wg-access-server these three never mattered for us in any of the existing issues.
Instead we could ask for config files or relevant parts of them, like the config.yaml or docker-compose.yml.

@@ -0,0 +1,20 @@
<!--- Use a prefix like [TASK], [BUGFIX], [DOC] or [CGL] and provide a general summary of your changes in the Title above -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We didn't use such prefixes until now and I'm not too big of a fan of them. I'd short the sentence to simply

<!--- Provide a general summary of your changes in the Title above -->

<!--- If it fixes an open issue, please link to the issue here. -->

## How Has This Been Tested?
<!--- Please try to test the code in multiple browsers and also on a mobile device -->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to the "Your environment" section above, this often doesn't make sense, e.g. if the PR only touches backend code. Maybe it could be made a bit more generic?

<!--- Please try to test the code in multiple situations and with different settings that could influence it -->

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] My code follows the code style of this project. (CI will test it anyway and also needs approval)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For wg-access-server it would be useful to point people towards go fmt, Go's built-in formatter. But that's very project-/language-specific, so it doesn't fit here I guess.

@GoliathLabs GoliathLabs deleted the templates branch May 23, 2022 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a proper PR / Issue template to this repo
2 participants