2.7 KiB
Developing Neutrino
Developing and contributing to Neutrino and its core presets is done through our monorepo located at https://github.com/mozilla-neutrino/neutrino-dev. The code is broken up into a couple different sections: packages and documentation.
Note: In this guide, commands executable from the command line are prepended with ❯. Lines not starting
with this symbol show sample console output from running the previous command.
Getting started
The first step to start developing neutrino-dev is forking the repository to your own GitHub account.
Fork mozilla-neutrino/neutrino-dev on GitHub
Once that is done, you can clone your copy of the repository on your computer, replacing USER with the username
of the account you forked the repository to:
❯ git clone git@github.com:USER/neutrino-dev.git
❯ cd neutrino-dev
Making changes
When you make changes to neutrino-dev, you should make them in a branch separate from master. Start from the
master branch and create a new branch for your changes.
Example: You want to create a core preset for JavaScript Standard Style. You need a new branch for this work.
❯ git checkout -b standard-style
Switched to a new branch 'standard-style'
While making changes, be sure to test your code out for expected operation. If possible or applicable, write a test that can verify these changes in the future.
Submitting a pull request
Once you are satisified with your changes, you should commit them and submit a pull request. Use git add
in order to add files that should be commited. Give your changes a descriptive but not overly verbose message.
❯ git add .
❯ git commit -m "Feature: Adding new core preset for JavaScript Standard Style"
❯ git push origin standard-style
Now if you open the GitHub page for your repository, GitHub should display a button to open a pull request for the branch and commit you just pushed. When filling out the details of the pull request, try to be as descriptive as possible, following our detailed contribution guidelines.
Receiving updates
If you need to update your local copy of neutrino-dev to be in sync with the main neutrino-dev repository, you will want to fetch upstream changes. Add the main neutrino-dev repo as an upstream to your local copy, then fetch the latest changes from the master branch.
❯ git checkout master
❯ git remote add upstream https://github.com/mozilla-neutrino/neutrino-dev.git
❯ git pull upstream master
Congrats!
You just made a contribution to Neutrino! We are so happy to have your help! 🎉