Skip to content

Commit 0fda495

Browse files
docs: corrected developer docs links (#3450)
Co-authored-by: Damien Retzinger <[email protected]>
1 parent 3f35296 commit 0fda495

File tree

1 file changed

+18
-28
lines changed

1 file changed

+18
-28
lines changed

CONTRIBUTING.md

+18-28
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Stack Overflow is a much better place to ask questions since:
2626

2727
To save your and our time, we will systematically close all issues that are requests for general support and redirect people to Stack Overflow.
2828

29-
If you would like to chat about the question in real-time, you can reach out via [our gitter channel][gitter].
29+
If you would like to chat about the question in real-time, you can reach out via [our discord server][discord].
3030

3131
## <a name="issue"></a> Found a Bug?
3232
If you find a bug in the source code, you can help us by
@@ -50,15 +50,15 @@ and help you to craft the change so that it is successfully accepted into the pr
5050

5151
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
5252

53-
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we will systematically ask you to provide a minimal reproduction scenario using http://plnkr.co. Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions like:
53+
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs, we will systematically ask you to provide a minimal reproduction scenario using [Stackblitz][stackblitz]. Having a live, reproducible scenario gives us a wealth of important information without going back & forth to you with additional questions like:
5454

5555
- version of Daffodil used
5656
- 3rd-party libraries and their versions
5757
- and most importantly - a use-case that fails
5858

59-
A minimal reproduce scenario using http://plnkr.co/ allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem. If plunker is not a suitable way to demonstrate the problem (for example for issues related to our npm packaging), please create a standalone git repository demonstrating the problem.
59+
A minimal reproduce scenario using [Stackblitz][stackblitz] allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem. If Stackblitz is not a suitable way to demonstrate the problem (for example for issues related to our npm packaging), please create a standalone git repository demonstrating the problem.
6060

61-
We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal plunk. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.
61+
We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal stackblitz. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.
6262

6363
Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced.
6464

@@ -146,9 +146,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
146146
147147
* All features or bug fixes **must be tested** by one or more specs (unit-tests).
148148
* All public API methods **must be documented**. (Details TBC).
149-
* We follow [Google's JavaScript Style Guide][js-style-guide], but wrap all code at
150-
**100 characters**. An automated formatter is available, see
151-
[DEVELOPER.md](docs/DEVELOPER.md#clang-format).
149+
* We use various linting programs to automatically format our files. See the [developer docs][dev-doc] for more info.
152150
153151
## <a name="commit"></a> Commit Message Guidelines
154152
@@ -206,22 +204,15 @@ The scope should be the name of the npm package affected (as perceived by the pe
206204
207205
The following is the list of supported scopes:
208206
209-
#### Libraries
210-
* **branding**
211-
* **core**
212-
* **cart**
213-
* **checkout**
214-
* **design**
215-
* **driver**
216-
* **geography**
217-
* **product**
218-
* **newsletter**
219-
* **seo**
220-
221-
#### Apps
222-
* **all**
223-
* **demo**
224-
* **daffio**
207+
- [Any app name](https://github.com/graycoreio/daffodil/tree/develop/apps)
208+
- [Any library folder's name](https://github.com/graycoreio/daffodil/tree/develop/libs)
209+
210+
In the event that a changeset impacts many packages (i.e. a dependency upgrade), please forego use a scope at all i.e.
211+
212+
```
213+
feat: upgrade Angular to version 19
214+
```
215+
225216

226217
### Subject
227218
The subject contains a succinct description of the change:
@@ -243,12 +234,11 @@ reference GitHub issues that this commit **Closes**.
243234
A detailed explanation can be found in this [document][commit-message-format].
244235
245236
246-
[coc]: https://github.com/graycoreio/daffodil/code-of-conduct/blob/develop/CODE_OF_CONDUCT.md
237+
[coc]: https://github.com/graycoreio/daffodil/blob/develop/CODE_OF_CONDUCT.md
247238
[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
248-
[dev-doc]: https://github.com/graycoreio/daffodil/blob/develop/docs/DEVELOPER.md
239+
[dev-doc]: https://github.com/graycoreio/daffodil/blob/develop/docs/internal/DEVELOPER.md
249240
[github]: https://github.com/graycoreio/daffodil
250-
[gitter]: https://gitter.im/graycoreio/daffodil
241+
[discord]: https://discord.com/invite/BdaJVZ53sR
251242
[js-style-guide]: https://google.github.io/styleguide/jsguide.html
252-
[jsfiddle]: http://jsfiddle.net
253-
[plunker]: http://plnkr.co/edit
243+
[stackblitz]: https://stackblitz.com/github/graycoreio/stackblitz-projects/tree/main/ng18-daffodil-product-driver-switch
254244
[stackoverflow]: http://stackoverflow.com/questions/tagged/daffodil

0 commit comments

Comments
 (0)