We would love for you to contribute to Frontly CLI and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:
Before you submit your Pull Request (PR) consider the following guidelines:
-
Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.
-
Be sure that an issue describes the problem you're fixing, or documents the design for the feature you'd like to add. Discussing the design up front helps to ensure that we're ready to accept your work.
-
Fork the frontly/cli repository.
-
Make your changes in a new git branch:
git checkout -b fix/your-fix master
-
Create your patch, including appropriate test cases.
-
Follow our Coding Rules.
-
Run the full test suite, as described in the [developer documentation][dev-doc], and ensure that all tests pass.
-
Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.
git commit -a
Note: the optional commit
-acommand line option will automatically "add" and "rm" edited files. -
Push your branch to GitHub:
git push origin fix/your-fix
-
In GitHub, send a pull request to
cli:master.
-
If we suggest changes then:
-
Make the required updates.
-
Re-run the test suites to ensure tests are still passing.
-
Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
git rebase master -i git push -f
-
That's it! Thank you for your contribution!
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
-
Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
git push origin --delete fix/your-fix
-
Check out the master branch:
git checkout master -f
-
Delete the local branch:
git branch -D fix/your-fix
-
Update your master with the latest upstream version:
git pull --ff upstream master
To ensure consistency throughout the source code, keep these rules in mind as you are working:
- All features or bug fixes must be tested by one or more specs (unit-tests).
- All public API methods must be documented. (Details TBC).
- We follow [Google's JavaScript Style Guide][js-style-guide], but wrap all code at 100 characters. An automated formatter is available, see DEVELOPER.md.
We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the changelog.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
The footer should contain a closing reference to an issue if any.
Feel free to spice up the git messages with emojis. Use the gitmoji guide by Carlos Cuesta to create awesome commits.
Examples:
| Type | Code | Preview |
|---|---|---|
| New Features | :sparkles: |
✨ |
| Remove code & files | :fire: |
🔥 |
| Improving performance | :zap: |
⚡ |
| CI Changes | :construction_worker: |
👷 |
| Bug Fix | :bug: |
🐛 |
| Breaking Changes | :boom: |
💥 |
| Work on Docker | :whale: |
🐳 |
| UI Changes | :lipstick: |
💄 |
| Work on Lerna | :dragon: |
🐉 |
Samples:
docs(readme): update readme. :memo:
ci(travis): update travis config :construction_worker:
With this change, trvis will run the unit tests before building the project.
fix(ci): fix travis build failure :bug:
Travis was treating warning as failures which caused the build to fail. Adding CI=false at the beginning of the build command fixed the issue.
Fixes #125
Closes #168
PR Close #456
If the commit reverts a previous commit, it should begin with revert:, followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
Must be one of the following:
- build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
The scope should be the name of the npm package affected (as perceived by the person reading the changelog generated from commit messages.
The following is the list of supported scopes:
-
common
-
core
-
cli
-
plugins
-
vcs
-
npm
-
lerna
-
config
-
none/empty string: useful for
style,testandrefactorchanges that are done across all packages (e.g.style: add missing semicolons) and for docs changes that are not related to a specific package (e.g.docs: fix typo in tutorial).
The subject contains a succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- no dot (.) at the end
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.
A detailed explanation can be found in this [document][commit-message-format].