Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 998 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 998 Bytes

Contribution guidelines

First of all, thanks for thinking of contributing to this project. 😄

Before sending a Pull Request, consider making an issue in the repository and assigning it to yourself.

Development

You need to clone the repository and install dependencies.

git clone https://github.com/kristofferandreasen/react-announcement.git

Then you can install dependencies.

npm install

Now you are ready to add features to the component. The project is bootstrapped with create-react-library and TypeScript has been added to the project. You can read more about the development workflow in the project docs.

Run npm start in both the main directory and the example directory in two separate terminals. This way you will be able to see your changes on the example page when changes are made to the component.

npm start