Skip to content

Commit

Permalink
docs(contributing): add roadmap
Browse files Browse the repository at this point in the history
- fix yarn scripts
  • Loading branch information
theetrain authored and lzcabrera committed Aug 4, 2017
1 parent 9c7584f commit eb5f2fa
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,37 @@
# Contribution Guide

We’re so glad you’re thinking about contributing to the TELUS Design System! If you’re unsure about anything, just ask —
or submit your issue or pull request anyway. The worst that can happen is we’ll politely ask you to change something. We
We’re so glad you’re thinking about contributing to the TELUS Design System! If you’re unsure about anything, just ask —
or submit your issue or pull request anyway. The worst that can happen is we’ll politely ask you to change something. We
appreciate all friendly contributions.

If you have any questions, ping us on the #tds-tech-support or the #tds-guild Slack channel.
If you have any questions, ping us on the #tds-tech-support or the #tds-guild Slack channel.


## How to contribute to TDS

### Did you find a bug?

* Ensure the bug was not already reported by searching the Github [Issues](https://github.com/telusdigital/tds/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/telusdigital/tds/issues/new).
Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/telusdigital/tds/issues/new).
Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an
executable test case demonstrating the expected behavior that is not occurring.

### Did you fix a bug?

* First, thanks! :)
* Open a new GitHub pull request with the patch.
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
* Before submitting, please read the [Coding Standards](https://github.com/telusdigital/tds/wiki/Coding-Standards) guide
* Before submitting, please read the [Coding Standards](https://github.com/telusdigital/tds/wiki/Coding-Standards) guide
to know more about coding conventions.

### Do you have a suggestion for a new component or feature?

**We are not currently accepting pull requests for new components or features.**

* Ensure the component/feature is not already requested by searching the Github [Issues](https://github.com/telusdigital/tds/issues).
* If you're unable to find a feature request, [open a new one](https://github.com/telusdigital/tds/issues/new).
* Ensure the component/feature is not already requested by searching the Github [Issues](https://github.com/telusdigital/tds/issues) and viewing the [roadmap](https://app.roadmunk.com/publish/60cc76917916cae625476a6ec22b532a45a92526).
* If you're unable to find a feature request, open a new one by [creating an issue](https://github.com/telusdigital/tds/issues/new) to start a discussion.

When in doubt, please consult a TDS team member on brand alignment, reusable components, or new ideas.

## Contributing to the TDS code

Expand All @@ -40,7 +41,7 @@ After forking TDS, do the following steps to get started.

```sh
# Install yarn
brew install yarn
brew install yarn # alternatively: npm i -g yarn

# Install commitizen to write commit messages according to our preferred format.
yarn global add commitizen
Expand All @@ -54,23 +55,23 @@ yarn install

### Develop Components

This codebase uses [react-styleguidist](https://react-styleguidist.js.org) to document components, and
This codebase uses [react-styleguidist](https://react-styleguidist.js.org) to document components, and
[jest](https://facebook.github.io/jest/)/[enzyme](http://airbnb.io/enzyme/) for unit testing.

See the [Coding Standards](https://github.com/telusdigital/tds/wiki/Coding-Standards) guide to know more about coding
See the [Coding Standards](https://github.com/telusdigital/tds/wiki/Coding-Standards) guide to know more about coding
conventions.

```sh
# Start the docs server, check output for the location of the docs
yarn start:styleguide
yarn dev

# Open a new terminal window

# Start the test watcher
yarn test:watch
```

After this, you can open up a browser to view the documentation site (usually <http://localhost:6060>). The browser will
After this, you can open up a browser to view the documentation site (usually <http://localhost:6060>). The browser will
automatically refresh when there are changes to any of the source files.

### When you are ready to make a commit
Expand All @@ -85,5 +86,5 @@ git cz

### Make a Pull Request

When your branch is ready for review create a [pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
When your branch is ready for review, create a [pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
to the main TDS repository.

0 comments on commit eb5f2fa

Please sign in to comment.