Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

59 lines (35 loc) · 2.48 KB

Contributing to GOLD Design System

Hi there! Thank you for your interest in contributing to GOLD Design System, we really appreciate it.

Join the community on Slack.

There are many ways to contribute: – reporting bugs

  • fixing bugs
  • writing documentation
  • suggesting new features, please refer to the RFC process

Wherever you are, and whatever your discipline is, you are invited to contribute.

Contents

🚀 Initial set up

To set up the Design System site locally, do the following.

  • Visit the design system site repository
  • Clone or download the repository to your local machine.
  • Open the terminal and navigate to where you have saved the repository.
  • Enter npm install to install the components.
  • Enter npm run watch. A local instance of the website will launch in your browser.

⬆ back to top

Reporting Bugs, Asking Questions, Sending Suggestions

Use the search in issues to see if the same bug, question or suggestion has already been raised.

If you’re filing a bug, specific steps to reproduce are helpful. Please reference the module that has the bug, along with what you expected to see and what happened instead. For more info look at our issue template.

⬆ back to top

Content changes

We use a static site generator called cuttlebelle. This means that all of the content in our site lives in markdown files.

To contribute content we recommend first editing the files in the content folder.

You may want to undertake the Cuttlebelle tutorials to get a better idea on how to create new pages and layouts.

⬆ back to top