Skip to content

Commit e20eeb2

Browse files
author
Dennis Labordus
authored
Merge pull request #43 from com-pas/issue-usage-info
Issue usage info
2 parents 71b70dc + 1bdc82e commit e20eeb2

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

docs/HOME.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,15 @@ Everybody can suggest topics for the refinement. To do this, join the [LFEnergy
7373

7474
### Reporting Bugs and Suggesting Enhancements
7575

76-
Bugs and enhancement suggestions are tracked as [GitHub issues](https://guides.github.com/features/issues/). Create an issue
77-
and provide the following information by filling in [the template](ISSUE_TEMPLATE.md).
76+
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.
77+
78+
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.
79+
Once it's accepted and refined, it goes to the `Ready for development` column and it's ready to be implemented/fixed.
7880

7981
Before creating bug reports or suggesting enhancement, please **perform a [cursory search](https://github.com/search?q=+is%3Aissue+user%3Acom-pas)**
80-
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.
82+
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.
8183

82-
You can also contact the team directly to talk about your ideas at [[email protected]](mailto:CoMPAS-dev@lists.lfenergy.org).
84+
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 [[email protected]](mailto:[email protected]).
8385

8486
> **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.
8587

docs/PULL_REQUESTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@ request is used to generate the release notes.
1616
- ``enhancement``: The pull request adds as a new feature.
1717
- ``bug``: The pull request solves a bugfix.
1818
- ``tooling``: Change or update to tooling used to build project.
19+
- **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**.
1920

2021
There is a special label ``dependencies`` used by dependabot for updating dependencies.
21-
These are grouped together in a separate section.
22+
These are grouped together in a separate section.
2223
If no label is added the pull request will be added to the section ``Other Changes`` at the bottom of the release notes.
2324

2425
The following labels cause the pull request to be ignored in the release notes:

0 commit comments

Comments
 (0)