Contributing to the Plumes project
We'd love for you to contribute to our source code and to make this project even better and fun than it is today! Here are the guidelines we'd like you to follow:
- Code of Conduct
- Question or Problem?
- Issues and Bugs
- Feature Requests
- Submission Guidelines
- Coding Rules
- Commit Message Guidelines
- Further Info
As contributors and maintainers of the project, we pledge to respect everyone who contributes by posting issues, submitting pull requests, providing feedback in comments, and any other activities.
Communication through any of project's channels (GitHub, IRC, mailing lists, Google+, Twitter, etc.) must be constructive and never resort to personal attacks, trolling, public or private harrassment, insults, or other unprofessional conduct.
We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the project to do the same.
If any member of the community violates this code of conduct, the maintainers of the project may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate.
If you are subject to or witness unacceptable behavior, or have any other concerns, please contact us.
Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on StackOverflow where the questions should be tagged with tag
StackOverflow is a much better place to ask questions since:
- there are thousands of people willing to help on StackOverflow
- questions and answers stay available for public viewing so your question / answer might help someone else
- StackOverflow's voting system assures that the best answers are prominently visible.
To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.
If you would like to chat about the question in real-time, you can reach out via [our gitter channel][https://gitter.im/CodeCorico/plumes].
You can request a new feature by submitting an issue to the GitHub Repository. If you would like to implement a new feature then consider what kind of change it is:
- Major Changes that you wish to contribute to the project should be discussed first with us so that we can better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
- Small Changes can be crafted and submitted to the GitHub Repository as a Pull Request.
A new issue create a discussion thread. Other contributors can advise and contribute to your ideas. Please search whether the subject does not already exists on the opened issues before that to prevent duplicates issues.
Before you submit your issue please search the archive, maybe your question was already answered.
If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Providing the following information will increase the chances of your issue being dealt with quickly:
- Overview of the issue - if an error is being thrown a non-minified stack trace helps
- Motivation for or Use Case - explain why this is a bug for you
- Version(s) - is it a regression?
- Browsers and Operating System - is this a problem with all browsers or only IE8?
- Reproduce the error - provide a live example (using Plunker or JSFiddle) or a unambiguous set of steps.
- Related issues - has a similar issue been reported before?
- Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)
If you get help, help others. Good karma rulez!
Before you submit your pull request consider the following guidelines:
Search GitHub pulls for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.
Make your changes in a new git branch
git checkout -b my-fix-branch master
Create your patch, including appropriate test cases.
Follow the Coding Rules.
Commit your changes using a descriptive commit message that follows the commit message conventions.
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 my-fix-branch
In GitHub, send a pull request to
If we suggest changes then
Make the required updates.
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
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 my-fix-branch
Check out the master branch:
git checkout master -f
Delete the local branch:
git branch -D my-fix-branch
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 contributors.
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.
Commit Message Format
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>
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.
Must be one of the following:
- chore: Modifications on project details (like readme files)
- feat: A new feature
- fix: A bug fix
- rules: Modifications on rules
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- refactor: A code change that neither fixes a bug or adds a feature
- perf: A code change that improves performance
The scope could be anything specifying place of the commit change. For example
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize 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.
Only the lead contribution team can publish a new version. To do that, it requires that the milestone is completely finished (Milestones).
Publish the new version:
- Pull the last version of
- Define the new version number (format MAJOR.MINOR.REVISION)
- Update the
- Update the
CHANGELOG.mdfile with the new changes
- Commit these changes with
- Create a new tag on this commit named
[new version number](format: 0.0.0)
- Push the branch
- Push the new tag release with
git push --tags
- Publish on NPM with
Largely inspired file from https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md