Skip to content

chore: add versioning documentation #362

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 11, 2019
Merged

chore: add versioning documentation #362

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b90de2c
Initial versioning text
jzempel May 9, 2019
43629be
Updated based on initial review
jzempel May 22, 2019
e18289e
Merge branch 'master' into jzempel/versioning
jzempel Jun 11, 2019
a6adde7
Expose API and DEVELOPMENT documentation at root
jzempel Jun 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 0 additions & 138 deletions .github/API.md
View file
Open in desktop

This file was deleted.

18 changes: 11 additions & 7 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,24 @@ This is a multi-package repo which uses [Lerna](https://lernajs.io/) to
manage shared and cross-package dependencies. The basic repo layout
includes:

* `├── package.json` – the top-level "project" package that contains
<!-- markdownlint-disable -->

- `├── package.json` – the top-level "project" package that contains
the dependencies and scripts needed to manage the multi-package repo.
_This package will never be published to the registry._
* `└─── packages/` – the folder that contains individual `@zendeskgarden`
- `└─── packages/` – the folder that contains individual `@zendeskgarden`
packages which are published to the registry.<br>
&nbsp;&nbsp;&nbsp;&nbsp;`├── .template/` – a special template package referenced by `yarn
new` to generate a component.<br>
&nbsp;&nbsp;&nbsp;&nbsp;`├── .template/` – a special template package
referenced by `yarn new` to generate a component.<br>
&nbsp;&nbsp;&nbsp;&nbsp;`├── buttons/`<br>
&nbsp;&nbsp;&nbsp;&nbsp;`├── tabs/`<br>
&nbsp;&nbsp;&nbsp;&nbsp;`├── theming/`<br>
&nbsp;&nbsp;&nbsp;&nbsp;`└── etc.`

<!-- markdownlint-enable -->

For an overview of our component architecture and APIs, view our [API
documentation](API.md).
documentation](../API.md).

## Versioning Workflow

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

See our [development documentation](DEVELOPMENT.md) for package
See our [development documentation](../DEVELOPMENT.md) for package
implementation requirements.

## Pull Request Workflow
Expand Down
103 changes: 0 additions & 103 deletions .github/DEVELOPMENT.md
View file
Open in desktop

This file was deleted.

12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@

## Steps to Reproduce

1.
1.
1.
1.
1.
1.

<!--
BONUS POINTS: spin up and share an example via
Expand All @@ -23,6 +23,6 @@

### Fine Print

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