Skip to content

Commit 9a5dbd1

Browse files
authored
Initial simple README.md
See also sailfishos/jolla-camera#2
1 parent 011af5f commit 9a5dbd1

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,24 @@
1-
# issue-tracker
2-
Sailfish OS issue tracker
1+
# Sailfish OS issue tracker
2+
3+
Please report issues to [Issue Tracker](https://github.com/sailfishos/issue-tracker/issues) and use labels with issues.
4+
You can filter by [labels](https://github.com/sailfishos/issue-tracker/labels).
5+
6+
Worth noting that Issue tracker provides a bug report template when creating a new issue.
7+
8+
## Traceability
9+
10+
Please remember to add the issue link to a pull request (or a commit message). By doing this, GitHub adds
11+
the pull request / commit link to the issue. This is important from traceability point of view as occasionally
12+
you need to find additional details regarding the issue being it review comments, why and how change implemented like
13+
it is implemented, and so on. The reasoning is not always well documented in the commit message itself – or hard to
14+
elaborate briefly enough there. By doing like this one can see from the git history where to find more details. Similarly
15+
from the issue you can directly jump to the change itself. If there happens to be a Forum Bug regarding the issue, it
16+
would be good to link that as well to the pull request or to the commit message.
17+
18+
After a change is reviewed, Jolla Crew will take care of merging and integration.
19+
20+
## Contributing
21+
22+
Find contrubition guidelines from [the docs](https://docs.sailfishos.org/Develop/Collaborate/). Improvements are welcome!
23+
24+
Happy hacking.

0 commit comments

Comments
 (0)