Skip to content

Commit

Permalink
fix: cleaned up the docs and pipeline
Browse files Browse the repository at this point in the history
  • Loading branch information
zeddotes committed Oct 18, 2022
1 parent d570518 commit 6ca98b0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ This project uses [storybook](https://storybook.js.org/) to document and provide
$ npm run storybook
```

### Contribution
### New Features

New feature branches should be created from `main` and Pull Requests should be submitted with the base set as the `develop` branch. Ensure that you've linted and tested your changes locally before publishing any PRs.
Feature branches should be created from `main` and Pull Requests should be submitted with the base set as the `develop` branch. Ensure that you've linted and tested your changes locally before publishing any PRs.

#### Commit Messages

Expand Down
6 changes: 3 additions & 3 deletions src/stories/Introduction.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ This project uses [storybook](https://storybook.js.org/) to document and provide
$ npm run storybook
```

### Contribution
### New Features

New feature branches should be created from `main` and Pull Requests should be submitted with the base set as the `develop` branch. Ensure that you've linted and tested your changes locally before publishing any PRs.
Feature branches should be created from `main` and Pull Requests should be submitted with the base set as the `develop` branch. Ensure that you've linted and tested your changes locally before publishing any PRs.

#### Commit Messages

Expand Down Expand Up @@ -153,7 +153,7 @@ This will create a dts-stn-service-canada-design-system-0.0.0.tgz which you can

| Branch | Description | Associated Github Actions |
| :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------- |
| main | Production branch. Triggers a build to Storybook & publishes a new npm package release. | Publish Stable Package; Build and Deploy Storybook; Test |
| main | Production branch. Triggers a build to Storybook & publishes a new npm package release. | Publish Stable Package; Build and Deploy Storybook; Test |
| release | Final culmination of all branches that will be used to test beta versions of the new release. After testing is complete, release will be merged into main. | Publishing Dev Package; Create Pre-release notes PR for `release`; Test |
| develop | Culmination of feature branches | Test |
| \* | Created off of `main` to work on new features locally that are intended for the next potential release. Each feature branch should be prefixed by the relevant Jira issue and component ID (if applicable), eg. DS-56-A003-Footer. Feature branches should be merged into develop using a PR. | Test |
Expand Down

0 comments on commit 6ca98b0

Please sign in to comment.