From 45d37c16f27b5f1af804a27930af024c17aceb05 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Raine=20M=C3=A4kel=C3=A4inen?= Date: Wed, 15 Oct 2025 15:52:34 +0300 Subject: [PATCH] Initial simple README.md See also https://github.com/sailfishos/jolla-camera/pull/2 --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c62f236..5f60163 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,24 @@ -# issue-tracker -Sailfish OS issue tracker +# Sailfish OS issue tracker + +Please report issues to [Issue Tracker](https://github.com/sailfishos/issue-tracker/issues) and use labels with issues. +You can filter by [labels](https://github.com/sailfishos/issue-tracker/labels). + +Worth noting that Issue tracker provides a bug report template when creating a new issue. + +## Traceability + +Please remember to add the issue link to a pull request (or a commit message). By doing this, GitHub adds +the pull request / commit link to the issue. This is important from traceability point of view as occasionally +you need to find additional details regarding the issue being it review comments, why and how change implemented like +it is implemented, and so on. The reasoning is not always well documented in the commit message itself – or hard to +elaborate briefly enough there. By doing like this one can see from the git history where to find more details. Similarly +from the issue you can directly jump to the change itself. If there happens to be a Forum Bug regarding the issue, it +would be good to link that as well to the pull request or to the commit message. + +After a change is reviewed, Jolla Crew will take care of merging and integration. + +## Contributing + +Find contribution guidelines from [the docs](https://docs.sailfishos.org/Develop/Collaborate/). Improvements are welcome! + +Happy hacking.