Skip to content

Commit 8b6bd14

Browse files
committed
[INTERNAL] Update contributing guidelines
Rephrasing, updated labels, updated links
1 parent 21f164c commit 8b6bd14

File tree

2 files changed

+12
-22
lines changed

2 files changed

+12
-22
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,16 @@ Go to [the Github issue tracker](https://github.com/SAP/ui5-tooling/issues?state
1111
Additional work may be further information or a hint that helps understanding the issue. Maybe you can even identify the root cause and [contribute](#contribute-code) a bugfix?
1212

1313
## Report an Issue
14-
If you find a bug you are welcome to report it.
15-
We can only handle well-reported, actual bugs, so please follow the guidelines below and use forums like [StackOverflow](http://stackoverflow.com/questions/tagged/sapui5) for support questions or when in doubt whether the issue is an actual bug.
16-
17-
Once you have familiarized with the guidelines, you can go to the [Github issue tracker](https://github.com/SAP/ui5-tooling/issues/new) to report the issue.
14+
### Questions / Not a bug
15+
If you need help setting something up or if you have a question regarding the UI5 Build and Development Tooling, please seek help on a platform like [StackOverflow](http://stackoverflow.com/questions/tagged/ui5-tooling) or in the `#tooling` channel of the [OpenUI5 Community Slack](https://slackui5invite.herokuapp.com).
1816

1917
### Requirements for a bug report
20-
These eight requirements are the mandatory base of a good bug report:
18+
These requirements are the foundation of a good bug report:
2119

22-
1. **Only real bugs**: please do your best to make sure to only report real bugs! Do not report:
20+
1. **Only UI5 Build and Development Tooling issues**: Please do not report:
2321
* issues caused by dependencies or plugins.
2422
* issues caused by the usage of non-public/internal methods. Only the public methods listed in the API documentation may be used.
25-
* something that behaves just different from what you expected. A bug is when something behaves different than specified. When in doubt, ask in a forum.
26-
* something you do not get to work properly. Use a support forum like [StackOverflow](http://stackoverflow.com/questions/tagged/sapui5) to request help.
23+
- something you do not get to work properly. Seek help on a platform like [StackOverflow](http://stackoverflow.com/questions/tagged/ui5-tooling) or in the `#tooling` channel of the [OpenUI5 Community Slack](https://slackui5invite.herokuapp.com)
2724
2. **No duplicate**: you have searched the issue tracker to make sure the bug has not yet been reported
2825
3. **Good summary**: the summary should be specific to the issue
2926
4. **Current bug**: the bug can be reproduced in the most current version (state the tested version!)
@@ -38,11 +35,6 @@ You are encouraged to use [this template](ISSUE_TEMPLATE.md).
3835

3936
Please report bugs in English, so all users can understand them.
4037

41-
### Issue handling process
42-
When an issue is reported, a committer will look into it and either confirm it as a real issue (by giving the "approved" label), close it if it is not an issue, or ask for more details. Approved issues are then either assigned to a committer in GitHub, reported in our internal issue handling system, or left open as "contribution welcome" for easy or not urgent fixes.
43-
44-
An issue that is about a real bug is closed as soon as the fix is committed.
45-
4638
### Reporting Security Issues
4739
If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited:
4840
* SAP Customers: if the found security issue is not covered by a published security note, please report it by creating a customer message at https://service.sap.com/message.
@@ -59,17 +51,13 @@ Labels for issue categories:
5951
* enhancement: this is not a bug report, but an enhancement request
6052

6153
Status of open issues:
62-
* unconfirmed: this report needs confirmation whether it is really a bug (no label; this is the default status)
63-
* approved: this issue is confirmed to be a bug
64-
* author action: the author is required to provide information
65-
* contribution welcome: this fix/enhancement is approved and you are invited to contribute it
54+
* information required: the author is required to provide information
55+
* good first issue: A newcomer may work on this
56+
* help wanted: Additional help in analyzing this issue is appreciated
6657

6758
Status/resolution of closed issues:
68-
69-
* fixed: a fix for the issue was provided
70-
* duplicate: the issue is also reported in a different ticket and is handled there
59+
* duplicate: the issue was already reported somewhere else
7160
* invalid: for some reason or another this issue report will not be handled further (maybe lack of information or issue does not apply anymore)
72-
* works: not reproducible or working as expected
7361
* wontfix: while acknowledged to be an issue, a fix cannot or will not be provided
7462

7563
The labels can only be set and modified by committers.

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
![UI5 logo](./docs/images/UI5_logo_wide.png)
22

3+
[![OpenUI5 Community Slack (#tooling channel)](https://slackui5invite.herokuapp.com/badge.svg)](https://slackui5invite.herokuapp.com)
4+
35
# [UI5](https://ui5.sap.com) Build and Development Tooling
46
**This is a Pre-Alpha release!**
57
**The UI5 Build and Development Tooling described here is not intended for productive use yet. Breaking changes are to be expected.**
@@ -180,7 +182,7 @@ Apparently, the modules of the UI5 Build and Development Tooling as well as the
180182
Please check our [Contribution Guidelines](/CONTRIBUTING.md).
181183

182184
## Support
183-
Please follow our [Contribution Guidelines](/CONTRIBUTING.md#report-an-issue) on how to report an issue.
185+
Please follow our [Contribution Guidelines](/CONTRIBUTING.md#report-an-issue) on how to report an issue. Or chat with us in the `#tooling` channel of the [OpenUI5 Community Slack](https://slackui5invite.herokuapp.com)
184186

185187
## License
186188
This project is licensed under the Apache Software License, Version 2.0 except as noted otherwise in the [LICENSE](/LICENSE.txt) file.

0 commit comments

Comments
 (0)