Skip to content

Docs/create community files#315

Merged
brarcher merged 3 commits intolibcheck:masterfrom
jflopezfernandez:docs/create-community-files
Nov 4, 2020
Merged

Docs/create community files#315
brarcher merged 3 commits intolibcheck:masterfrom
jflopezfernandez:docs/create-community-files

Conversation

@jflopezfernandez
Copy link
Copy Markdown
Collaborator

I created an ISSUE_TEMPLATE directory in the .github project directory to allow us to pre-populate bug-report related issues and speed up the turnaround time by being able to skip the information request phase, letting us get right into the verification, diagnosis, fix, and test phases.

I created a GitHub issue template specifically for bug
reports to help streamline the process of pinning down,
replicating, verifying, and fixing user-reported issues.
The config.yml at the root of the .github/ISSUE_TEMPLATE
directory controls the issue templates configuration for
the project directory.

Eventually, it would be nice to not have to accept blank
issues, since having an issue template for each kind of
issue helps speed up the process by allowing us to define
the necessary information we need up front.

While we create the issue templates, however, I'm leaving
blank issues enabled.

I also added the user mailing list address from the website
in case someone prefers to seek the wisdom therein.
Comment thread .github/ISSUE_TEMPLATE/config.yml Outdated
blank_issues_enabled: true
contact_links:
- name: Check Library Users Mailing List
url: check-users@sourceforge.net
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we direct users to post questions on GitHub rather that the mailing list?

Sometimes users include attachments with their questions (like screenshots). if they are too big an admin of the mailing list needs to approve it. It would be easier if the questions (and their attachments) were handled by GitHub. It may be easier to discover similar questions if they are all on GitHub as well.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yea, I agree; I saw the configuration file allowed for including the development mailing list and I thought it might look nice and official, but I think including it might be counterproductive. I didn't know about the mailing list attachment size limit, either.

As discussed in the pull request (libcheck#315), the user mailing
list has been removed to prevent the bifurcation of the
user base.

It is preferable to have all user questions, feature
requests, and bug reports filed here via the GitHub issues
feature.

Discussion: libcheck#315 (comment)
@brarcher brarcher merged commit a2ca02c into libcheck:master Nov 4, 2020
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.

2 participants