Skip to content

Commit e01d844

Browse files
authored
chore: add versioning documentation (#362)
1 parent a24a028 commit e01d844

File tree

8 files changed

+370
-255
lines changed

8 files changed

+370
-255
lines changed

.github/API.md

Lines changed: 0 additions & 138 deletions
This file was deleted.

.github/CONTRIBUTING.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,24 @@ This is a multi-package repo which uses [Lerna](https://lernajs.io/) to
1212
manage shared and cross-package dependencies. The basic repo layout
1313
includes:
1414

15-
* `├── package.json` – the top-level "project" package that contains
15+
<!-- markdownlint-disable -->
16+
17+
- `├── package.json` – the top-level "project" package that contains
1618
the dependencies and scripts needed to manage the multi-package repo.
1719
_This package will never be published to the registry._
18-
* `└─── packages/` – the folder that contains individual `@zendeskgarden`
20+
- `└─── packages/` – the folder that contains individual `@zendeskgarden`
1921
packages which are published to the registry.<br>
20-
&nbsp;&nbsp;&nbsp;&nbsp;`├── .template/` a special template package referenced by `yarn
21-
new` to generate a component.<br>
22+
&nbsp;&nbsp;&nbsp;&nbsp;`├── .template/` a special template package
23+
referenced by `yarn new` to generate a component.<br>
2224
&nbsp;&nbsp;&nbsp;&nbsp;`├── buttons/`<br>
2325
&nbsp;&nbsp;&nbsp;&nbsp;`├── tabs/`<br>
2426
&nbsp;&nbsp;&nbsp;&nbsp;`├── theming/`<br>
2527
&nbsp;&nbsp;&nbsp;&nbsp;`└── etc.`
2628

29+
<!-- markdownlint-enable -->
30+
2731
For an overview of our component architecture and APIs, view our [API
28-
documentation](API.md).
32+
documentation](../API.md).
2933

3034
## Versioning Workflow
3135

@@ -58,12 +62,12 @@ commands are available:
5862
- `yarn build` to rebuild distributions across all packages.
5963
The build runs as part of the initial install. Operates as a facade
6064
over a Lerna command; operation may be modified using option
61-
[flags](https://github.com/lerna/lerna#flags) (i.e. `scope`, `since`,
65+
[flags](https://github.com/lerna/lerna#flags) (i.e. `scope`, `since`,
6266
or `ignore`).
6367
- `yarn new` to generate a new React component based on a package
6468
template.
6569

66-
See our [development documentation](DEVELOPMENT.md) for package
70+
See our [development documentation](../DEVELOPMENT.md) for package
6771
implementation requirements.
6872

6973
## Pull Request Workflow

.github/DEVELOPMENT.md

Lines changed: 0 additions & 103 deletions
This file was deleted.

.github/ISSUE_TEMPLATE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212

1313
## Steps to Reproduce
1414

15-
1.
16-
1.
17-
1.
15+
1.
16+
1.
17+
1.
1818

1919
<!--
2020
BONUS POINTS: spin up and share an example via
@@ -23,6 +23,6 @@
2323

2424
### Fine Print
2525

26-
* Component: <!-- buttons -->
27-
* Version: <!-- your issue might already be fixed with the latest version -->
28-
* Browsers: all
26+
- Component: <!-- buttons -->
27+
- Version: <!-- your issue might already be fixed with the latest version -->
28+
- Browsers: all

0 commit comments

Comments
 (0)