From 4a45338c6ae99ab59da38d4372f8961b1f8dd680 Mon Sep 17 00:00:00 2001 From: Ingo Schommer Date: Wed, 29 Jul 2020 16:13:21 +1200 Subject: [PATCH] DOCS Per-project issue tracking shortcut (#9554) --- docs/en/05_Contributing/00_Issues_and_Bugs.md | 22 +++++++++++++++++++ docs/en/05_Contributing/01_Code.md | 2 +- 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/en/05_Contributing/00_Issues_and_Bugs.md b/docs/en/05_Contributing/00_Issues_and_Bugs.md index 9a46ffff8..e67c14883 100644 --- a/docs/en/05_Contributing/00_Issues_and_Bugs.md +++ b/docs/en/05_Contributing/00_Issues_and_Bugs.md @@ -62,3 +62,25 @@ read our guide on [how to write secure code](/developer_guides/security/secure_c * [forum.silverstripe.org](http://forum.silverstripe.org): Forums on silverstripe.org * [All issues across modules](https://www.silverstripe.org/community/contributing-to-silverstripe/github-all-core-issues) + +## Identifying issues and pull request relevant to your own project + +Our [issue browser](https://silverstripe-github-issues.now.sh/) can be helpful to identify known issues and pending pull requests in +[supported modules](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/). +But you're usually only running some of these modules, and others +from the [wider module ecosystem](https://addons.silverstripe.org). + +In order to only show issues and pull requests relevant to your project, +we've written a little [composer utility](https://github.com/silverstripe/silverstripe-github-issue-search-composer-util) +which inspects your own `composer.lock` file dependencies, +and searches across all Silverstripe modules in there. + +After [installing the composer utility](https://github.com/silverstripe/silverstripe-github-issue-search-composer-util), +use this command to pass through a lock file, and get a URL to open in your favourite browser. + +``` +cat /my/project/composer.lock | ss-issue-search get-url +``` + +Protip: You can further filter to certain [issue labels](code#labels) +such as `label:impact/high` to make the results more relevant. \ No newline at end of file diff --git a/docs/en/05_Contributing/01_Code.md b/docs/en/05_Contributing/01_Code.md index 716f41a08..32b7e59f4 100644 --- a/docs/en/05_Contributing/01_Code.md +++ b/docs/en/05_Contributing/01_Code.md @@ -122,7 +122,7 @@ If your change is particularly significant, it may be referred to the [forum](ht A core committer will also "label" your PR using the labels defined in GitHub, these are to correctly classify and help find your work at a later date. -#### GitHub Labels +#### GitHub Labels {#labels} The current GitHub labels are grouped into five sections: