From d0ec067ba53734e8e691ad14c95486274e4a3882 Mon Sep 17 00:00:00 2001 From: Flurb Date: Mon, 20 Jun 2022 22:00:11 +0200 Subject: [PATCH 1/3] Test Signed-off-by: Flurb --- docs/PULL_REQUESTS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/PULL_REQUESTS.md b/docs/PULL_REQUESTS.md index d0774b2..ffadd56 100644 --- a/docs/PULL_REQUESTS.md +++ b/docs/PULL_REQUESTS.md @@ -19,7 +19,7 @@ request is used to generate the release notes. There is a special label ``dependencies`` used by dependabot for updating dependencies. These are grouped together in a separate section. -If no label is added the pull request will be added to the section ``Other Changes`` at the bottom of the release notes. +If no label is added the pull request will be added to the section ``Other Changes`` at the bottom of the release notes. The following labels cause the pull request to be ignored in the release notes: - ``wontfix`` From 0084a5a6a19ecc2eac69390ed42ada46af40e020 Mon Sep 17 00:00:00 2001 From: Flurb Date: Mon, 20 Jun 2022 23:05:41 +0200 Subject: [PATCH 2/3] Added issue info Signed-off-by: Flurb --- .github/ISSUE_TEMPLATE.md | 29 +++++++++++++++++++++++++++++ docs/HOME.md | 10 ++++++---- docs/PULL_REQUESTS.md | 5 +++-- 3 files changed, 38 insertions(+), 6 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..c94e25c --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,29 @@ +# When requesting a feature + +As a .. + +I want to .. + +So that.. + +### Additional information if feature request + +Give us some extra information about the desired feature. + +# When reporting a bug + +### Subject of the issue +Describe your issue here. + +### Your environment +* Version of CoMPAS +* Which browser and its version + +### Steps to reproduce +Tell us how to reproduce this issue. + +### Expected behaviour +Tell us what should happen + +### Actual behaviour +Tell us what happens instead \ No newline at end of file diff --git a/docs/HOME.md b/docs/HOME.md index f9f6231..da76841 100644 --- a/docs/HOME.md +++ b/docs/HOME.md @@ -60,13 +60,15 @@ Note that checks will be performed during the integration in order to require th ### Reporting Bugs and Suggesting Enhancements -Bugs and enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue -and provide the following information by filling in [the template](ISSUE_TEMPLATE.md). +Bugs and enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue in the repository where it belongs (an issue about the CIM to IEC 61850 mapping belongs in the [CIM Mapping repository](https://github.com/com-pas/compas-cim-mapping) for example) and provide the following information by filling in [the template](../.github/ISSUE_TEMPLATE.md). If your request is a feature, you only need to fill in the `When requesting a feature` section. If it's a bug, fill in the `When reporting a bug` section. + +When an issue is created, it is automatically being added to the `To do` column of the specific repository. This means it's added, but not yet refined. Every monday at 10AM CET, there is a Community Refinement (see our mailing list [calendar](https://lists.lfenergy.org/g/CoMPAS/calendar), everybody can join) where issues are being discussed that are not refined yet. Your issue is one of them. +Once it's accepted and refined, it goes to the `Ready for development` column and it's ready to be implemented/fixed. Before creating bug reports or suggesting enhancement, please **perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Acom-pas)** -to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. +to see if the problem has already been reported. You can add a search term to the upper left search bar. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. -You can also contact the team directly to talk about your ideas at [CoMPAS-dev@lists.lfenergy.org](mailto:CoMPAS-dev@lists.lfenergy.org). +When in doubt, ask your question on our [LFEnergy slack](https://lfenergy.slack.com/) in the `#compas` channel. Or you can contact the team directly to talk about your ideas at [CoMPAS-dev@lists.lfenergy.org](mailto:CoMPAS@lists.lfenergy.org). > **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. diff --git a/docs/PULL_REQUESTS.md b/docs/PULL_REQUESTS.md index ffadd56..fddf24a 100644 --- a/docs/PULL_REQUESTS.md +++ b/docs/PULL_REQUESTS.md @@ -16,10 +16,11 @@ request is used to generate the release notes. - ``enhancement``: The pull request adds as a new feature. - ``bug``: The pull request solves a bugfix. - ``tooling``: Change or update to tooling used to build project. +- **Linking issue**: Link the correct issue using one of the [keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) in the description, for example `closes #1234`. **This only works when the PR is being merged to the default branch**. There is a special label ``dependencies`` used by dependabot for updating dependencies. -These are grouped together in a separate section. -If no label is added the pull request will be added to the section ``Other Changes`` at the bottom of the release notes. +These are grouped together in a separate section. +If no label is added the pull request will be added to the section ``Other Changes`` at the bottom of the release notes. The following labels cause the pull request to be ignored in the release notes: - ``wontfix`` From 1bdc82e0937d495080d2c4bcba32a4f09667d943 Mon Sep 17 00:00:00 2001 From: Flurb Date: Tue, 21 Jun 2022 15:16:30 +0200 Subject: [PATCH 3/3] Refactoring text Signed-off-by: Flurb --- .github/ISSUE_TEMPLATE.md | 29 ----------------------------- docs/HOME.md | 2 +- 2 files changed, 1 insertion(+), 30 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index c94e25c..0000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,29 +0,0 @@ -# When requesting a feature - -As a .. - -I want to .. - -So that.. - -### Additional information if feature request - -Give us some extra information about the desired feature. - -# When reporting a bug - -### Subject of the issue -Describe your issue here. - -### Your environment -* Version of CoMPAS -* Which browser and its version - -### Steps to reproduce -Tell us how to reproduce this issue. - -### Expected behaviour -Tell us what should happen - -### Actual behaviour -Tell us what happens instead \ No newline at end of file diff --git a/docs/HOME.md b/docs/HOME.md index da76841..69d346d 100644 --- a/docs/HOME.md +++ b/docs/HOME.md @@ -60,7 +60,7 @@ Note that checks will be performed during the integration in order to require th ### Reporting Bugs and Suggesting Enhancements -Bugs and enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue in the repository where it belongs (an issue about the CIM to IEC 61850 mapping belongs in the [CIM Mapping repository](https://github.com/com-pas/compas-cim-mapping) for example) and provide the following information by filling in [the template](../.github/ISSUE_TEMPLATE.md). If your request is a feature, you only need to fill in the `When requesting a feature` section. If it's a bug, fill in the `When reporting a bug` section. +Bugs and enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue in the repository where it belongs (an issue about the CIM to IEC 61850 mapping belongs in the [CIM Mapping repository](https://github.com/com-pas/compas-cim-mapping) for example) and provide the following information by filling in the template, which is either an issue or a bug. When an issue is created, it is automatically being added to the `To do` column of the specific repository. This means it's added, but not yet refined. Every monday at 10AM CET, there is a Community Refinement (see our mailing list [calendar](https://lists.lfenergy.org/g/CoMPAS/calendar), everybody can join) where issues are being discussed that are not refined yet. Your issue is one of them. Once it's accepted and refined, it goes to the `Ready for development` column and it's ready to be implemented/fixed.