Issues

Issue labels

Most of the issue labels should be self-explanatory, though it is here as a quick reference.

Label	Description
`bug`	Any issue with the main TaskCollect server which is resulting in unwanted behaviour. Bugs in build scripts and the like are not the primary focus of this label.
`documentation`	Updates to documentation, including doc comments in code.
`duplicate`	The issue already exists.
`enhancement`	A feature addition to the main source code. Typically does not refer to tests or build scripts.
`help wanted`	Help in fixing and/or reproducing the issue is wanted.
`invalid`	The issue is non-existent, or there is something wrong with the opened issue itself.
`question`	Opened issue is less of an issue, more of a question.
`refactor`	No feature additions to the code, rather, it is being rewritten to improve performance or code organisation.
`security`	An issue with security. These issues ought to be addressed ASAP.
`upstream`	The issue is not something that is present within TaskCollect itself, but rather, a library or API that TaskCollect utilises.

Opening an issue

Issue title

The issue title should be written in present tense, sentence case, and with no full-stop at the end. It should also be relatively short.

Good
Redesign the UI of the login page

Concise and to the point. Further elaboration can be done in the comments.

Bad
Redesign the UI of the login page because it is currently not good in mobile view.

Has a full-stop at the end.
Too long, the fact that it is not good in mobile view can be elaborated upon in the comments (the hows and whys are for comments).

Things to include

The issue should generally fall under one of the following categories:

bug
documentation
feature request
suggestion

If you are describing an issue with the TaskCollect program (both client-side and server-side issues), you should be including the version number. You can copy this information from the start of the console output, or if you have logging to file enabled, you can access it there too. The version is formatted with the version number and the commit hash. It should look something like so:

TaskCollect 1.0.3 (build fbfc86bf0fc60f7d92fa043655f8b9ed5da94275)

Including the appropriate output of the logs is also best practice. This will make it easier to reproduce and pinpoint the issue. Any issues regarding things like documentation, tests, or build scripts are not required to include the TaskCollect version number unless relevant.

Making proposals for where the solution may lie is definitely encouraged.

Making a pull request

While you are in no way obligated to make a pull request that fixes the issue you have identified, it would be very helpful if you are able to do so.

If the pull request addresses a specific issue, or multiple issues for that matter, include the issue number (e.g. #10) in the comments.