slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: ISSUES etc: drop "topics", call them labels

Browse Source
This commit is contained in:
Simon Michael 2022-12-09 07:40:34 -10:00
parent b609ba30ab
commit 53ed194a12
4 changed files with 30 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/COMMITS.md
View File

@ -51,7 +51,7 @@ Some possible prefixes:
- `doc` - documentation-related
- `test` - tests-related
- `ci` - continuous integration-related
- Any of the standard [topics](ISSUES.html#topics) used in the issue tracker.
- Any of the standard [labels](ISSUES.html#labels) used in the issue tracker.
## How to check commits

9
doc/CONTRIBUTING.md
View File

@ -7,13 +7,12 @@
New contributors are always welcome in the hledger project.
Jump in!
Browse the ideas below,
or [join the chat](support.html) and tell us your interests.
Browse the ideas below, or join the chat and we'll help find you a job.
## About the project
See [About FAQ](faq.html).
## First steps
- Join the [chat](support.html)
- Skim the [FAQs](faq.html)
## Ideas for contributing as a ...

55
doc/ISSUES.md
View File

@ -5,6 +5,14 @@
<!-- toc -->
</div>
The hledger project\'s issue tracker is on github. It contains:
- BUG issues - failures in some part of the hledger project (the main
hledger packages, docs, website..)
- WISH issues - feature proposals, enhancement requests
- uncategorised issues - we don\'t know what these are yet
- pull requests - proposed changes to code and docs
## Quick urls
- <http://issues.hledger.org> - all issues, open or closed
@ -23,7 +31,7 @@ Editing it may require editor support, search/replace etc.
Syntax: https://www.pandoc.org/MANUAL.html#tables -> pipe_tables
-->
| COMPONENT/TOPIC [*](#topics) | BUGS | WISHES | PRS | OTHER
| COMPONENT/TOPIC | BUGS | WISHES | PRS | OTHER
|----------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------
| [all](https://github.com/simonmichael/hledger/issues?q=is:open) | [bugs](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+label:%22A+BUG%22) ([first](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+label:%22A+BUG%22+label:%22good+first+issue%22)/[easy](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+label:%22A+BUG%22+-label:%22good+first+issue%22+label:easy?)/[neither](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+label:%22A+BUG%22+-label:%22good+first+issue%22+-label:easy?)) | [wishes](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+label:%22A+WISH%22) | [PRs](https://github.com/simonmichael/hledger/issues?q=is:open+is:pr) | [other](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+-label:%22A+BUG%22+-label:%22A+WISH%22)
| **Tools:**
@ -69,17 +77,6 @@ Syntax: https://www.pandoc.org/MANUAL.html#tables -> pipe_tables
| [tools](https://github.com/simonmichael/hledger/issues?q=is:open+label:tools) (dev tools, infrastructure)   | [bugs](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+label:%22A+BUG%22+label:tools) ([first](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+label:%22A+BUG%22+label:%22good+first+issue%22+label:tools)/[easy](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+label:%22A+BUG%22+-label:%22good+first+issue%22+label:easy?+label:tools)/[neither](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+label:%22A+BUG%22+-label:%22good+first+issue%22+-label:easy?+label:tools)) | [wishes](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+label:%22A+WISH%22+label:tools) | [PRs](https://github.com/simonmichael/hledger/issues?q=is:open+is:pr+label:tools) | [other](https://github.com/simonmichael/hledger/issues?q=is:open+is:issue+-label:%22A+BUG%22+-label:%22A+WISH%22+label:tools)
##
The hledger project\'s issue tracker is on github. It contains:
- BUG issues - failures in some part of the hledger project (the main
hledger packages, docs, website..)
- WISH issues - feature proposals, enhancement requests
- uncategorised issues - we don\'t know what these are yet
- pull requests - proposed changes to code and docs
Issues are also labelled according to their [topics](#topics), for organisation.
Some loose conventions:
@ -93,30 +90,20 @@ Some loose conventions:
## Labels
Labels are used to categorise:
<https://github.com/simonmichael/hledger/labels>,
also listed at [open issues](#open-issues) above,
are used to categorise:
- the issue\'s type: \"A BUG\" or \"A WISH\", in shades of red (The A
makes it appear as first label)
- relevant subsystems/topics, in light blue. More about this below.
- relevant platforms, in light purple
- resolution if not fixed:
\"closed:cant-reproduce/duplicate/invalid/wont-fix\", in dark grey
- \"bounty\", in bright yellow: issues with bountysource funding
- \"easy?\", in dim yellow: issues which are probably relatively easy
to fix
- \"imported\" etc., in white: miscellaneous information
- whether an issue is a bug (red) or a wish (pink)
- related subcomponents (tools, commands, input/output formats) (light blue)
- related general topics (light green)
- related platforms (light purple)
- whether a bounty has been offered (dark green)
- why an issue is blocked (dark grey) or was closed (black)
- low priority info, like "imported" (white)
## Topics
Short topic names, corresponding to hledger commands, input formats, output formats and other common themes,
are used to organise things in the hledger project. In particular,
- They are used as space saving descriptive prefixes for [commit messages](#commit-messages)
- They can be used as prefixes for issue/PR titles
- Issues and PRs are labelled with them (the light blue labels).
A more or less complete list can be seen at [open issues](#open-issues)
or in the issue tracker's labels list.
Labels can also be used as prefixes in issue/PR titles,
as prefixes in [commit messages](#commit-messages), etc.
## Custodians

7
doc/PULLREQUESTS.md
View File

@ -70,9 +70,10 @@ Rebase your commits against latest master for easiest review. Especially if they
We like to use some conventions in commit messages when it makes sense. These aren't mandatory, but appreciated:
- prepend a [topic](#topics) prefix, eg `cli: ` or `journal: `, for clarity and to help with changelog production
- prepend a semicolon (`;`) to indicate commits that need not be mentioned in changelogs/release notes (as in the Emacs project)
- append a final `[ci skip]` line to indicate commits that need not trigger a CI build, to reduce carbon emissions from Travis.
- prepend a [label](ISSUES.html#labels) prefix, eg `cli: ` or `journal: `, for clarity and to help with changelog production
- prepend a semicolon (`;`) to indicate commits that
- need not trigger a CI workflows, reducing wasteful carbon emissions
- and probably need not be mentioned in changelogs/release notes
## The docs