From f8a2811d9046bd0239ccab57e7b22c95513cd174 Mon Sep 17 00:00:00 2001 From: Matthias Date: Tue, 3 May 2022 00:55:29 +0200 Subject: [PATCH 1/3] change hierarchy --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82cfa4e9e2..cf86e4cdc5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,7 @@ The HEAD of the "main" or "master" branch of InvenTree represents the current "l **No pushing to master:** New featues must be submitted as a pull request from a separate branch (one branch per feature). -#### Feature Branches +### Feature Branches Feature branches should be branched *from* the *master* branch. @@ -45,7 +45,7 @@ The HEAD of the "stable" branch represents the latest stable release code. - The bugfix *must* also be cherry picked into the *master* branch. ## Environment -#### Target version +### Target version We are currently targeting: | Name | Minimum version | |---|---| @@ -65,7 +65,7 @@ pyupgrade `find . -name "*.py"` django-upgrade --target-version 3.2 `find . -name "*.py"` ``` -### Credits +## Credits If you add any new dependencies / libraries, they need to be added to [the docs](https://github.com/inventree/inventree-docs/blob/master/docs/credits.md). Please try to do that as timely as possible. From 1c0c3f9a729ce8da321cc59d725c64d548580367 Mon Sep 17 00:00:00 2001 From: Matthias Date: Tue, 3 May 2022 01:16:44 +0200 Subject: [PATCH 2/3] Add tags --- CONTRIBUTING.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf86e4cdc5..3786a01ab8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -124,4 +124,44 @@ HTML and javascript files are passed through the django templating engine. Trans {% load i18n %} {% trans "This string will be translated" %} - this string will not! -``` \ No newline at end of file +``` + +## Github use +### Tags +The tags describe issues and PRs in multiple areas: +| Area | Name | Description | +|---|---|---| +| Inventree Features | | | +| | feat: API | tbd | +| | feat: barcode | tbd | +| | feat: build | tbd | +| | feat: docker | tbd | +| | feat: importer | tbd | +| | feat: order | tbd | +| | feat: part | tbd | +| | feat: plugin | tbd | +| | feat: pricing | tbd | +| | feat: report | tbd | +| | feat: setup | tbd | +| | feat: stock | tbd | +| | feat: user interface | tbd | +| Type | | | +| | typ: bug | tbd | +| | typ: dependencies | tbd | +| | typ: enhancement | tbd | +| | typ: security | tbd | +| | typ: question | tbd | +| | typ: roadmap | tbd | +| State | | | +| | state: duplicate | tbd | +| | state: invalid | tbd | +| | state: no-activity | tbd | +| | state: duplicate | tbd | +| | state: wontfix | tbd | +| Ecosystem | | | +| | eco: app | tbd | +| | eco: CI | tbd | +| | eco: demo | tbd | +| Built in | | | +| | help wanted | tbd | +| | starter | tbd | From e10ee91109372b3381576171ada869227e8ea415 Mon Sep 17 00:00:00 2001 From: Matthias Date: Tue, 3 May 2022 01:19:08 +0200 Subject: [PATCH 3/3] make names clearer --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3786a01ab8..145f50aa69 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -131,7 +131,7 @@ HTML and javascript files are passed through the django templating engine. Trans The tags describe issues and PRs in multiple areas: | Area | Name | Description | |---|---|---| -| Inventree Features | | | +| Feature | | | | | feat: API | tbd | | | feat: barcode | tbd | | | feat: build | tbd | @@ -162,6 +162,6 @@ The tags describe issues and PRs in multiple areas: | | eco: app | tbd | | | eco: CI | tbd | | | eco: demo | tbd | -| Built in | | | +| GH Built in | | | | | help wanted | tbd | | | starter | tbd |