20 lines
713 B
Markdown
20 lines
713 B
Markdown
# Contributing to AdminKit
|
|
|
|
If you're reading this, you're awesome! Thank you for helping us make this project great. Here are a few guidelines that will help you along the way.
|
|
|
|
## Submitting a Pull Request
|
|
|
|
* Include **screenshots** or animated GIFs in your pull request whenever possible
|
|
* Use the **present** tense ("Add feature" not "Added feature")
|
|
* Use the **imperative** mood ("Move cursor to..." not "Moves cursor to...")
|
|
* Limit the first line to 72 characters or fewer
|
|
* Reference issues and pull requests liberally
|
|
|
|
## Try your changes
|
|
|
|
When modifying any of the files located in the `/src` folder, you will need to recompile the assets. You can do this by running:
|
|
|
|
```
|
|
npm install
|
|
npm run build
|
|
``` |