Skip to content

Commit 0084a5a

Browse files
author
Flurb
committed
Added issue info
Signed-off-by: Flurb <[email protected]>
1 parent d0ec067 commit 0084a5a

File tree

3 files changed

+38
-6
lines changed

3 files changed

+38
-6
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# When requesting a feature
2+
3+
As a ..
4+
5+
I want to ..
6+
7+
So that..
8+
9+
### Additional information if feature request
10+
11+
Give us some extra information about the desired feature.
12+
13+
# When reporting a bug
14+
15+
### Subject of the issue
16+
Describe your issue here.
17+
18+
### Your environment
19+
* Version of CoMPAS
20+
* Which browser and its version
21+
22+
### Steps to reproduce
23+
Tell us how to reproduce this issue.
24+
25+
### Expected behaviour
26+
Tell us what should happen
27+
28+
### Actual behaviour
29+
Tell us what happens instead

docs/HOME.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,15 @@ Note that checks will be performed during the integration in order to require th
6060

6161
### Reporting Bugs and Suggesting Enhancements
6262

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

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

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

7173
> **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.
7274

docs/PULL_REQUESTS.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,11 @@ 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-
If no label is added the pull request will be added to the section ``Other Changes`` at the bottom of the release notes.
22+
These are grouped together in a separate section.
23+
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:
2526
- ``wontfix``

0 commit comments

Comments
 (0)