mirror of
https://github.com/LaCasemate/fab-manager.git
synced 2024-12-04 15:24:23 +01:00
1.3 KiB
1.3 KiB
Contributing
Important notes
Please don't edit files in the dist
subdirectory as they are generated via Grunt. You'll find source code in the src
subdirectory!
Code style
Regarding code style like indentation and whitespace, follow the conventions you see used in the source already.
Modifying the code
First, ensure that you have the latest Node.js and npm installed.
Test that Grunt's CLI and Bower are installed by running grunt --version
and bower --version
. If the commands aren't found, run npm install -g grunt-cli bower
. For more information about installing the tools, see the getting started with Grunt guide or bower.io respectively.
- Fork and clone the repo.
- Run
npm install
to install all build dependencies (including Grunt). - Run
bower install
to install the front-end dependencies. - Run
grunt
to grunt this project.
Assuming that you don't see any red, you're ready to go. Just be sure to run grunt
after making any changes, to ensure that nothing is broken.
Submitting pull requests
- Create a new branch, please don't work in your
master
branch directly. - Update the documentation to reflect any changes.
- Push to your fork and submit a pull request.