We welcome contributions and we are always thinking about new ways to improve the generator and our source code. Here are the guidelines we'd like you to follow:
If you have questions about how to use Bannertime, please direct these to Slack.
If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Repository. Even better you can submit a Pull Request with a fix.
Please see the Submission Guidelines below.
You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature then consider what kind of change it is:
If you want to help improve the docs, it's a good idea to let others know what you're working on to minimize duplication of effort. Before starting, check out the issue queue for Milestone:Documentation. Comment on an issue to let others know what you're working on, or create a new issue if your work doesn't fit within the scope of any of the existing doc fix projects.
Before you submit your issue 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:
.yo-rc.jsonis highly appreciated.
Before you submit your pull request consider the following guidelines:
git checkout -b my-fix-branch develop
git commit -a
Note: the optional commit
-a command line option will automatically "add" and "rm" edited files.
git push origin my-fix-branch
git rebase develop -i git push origin my-fix-branch -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:
git push origin --delete my-fix-branch
git checkout develop -f
git branch -D my-fix-branch
git pull --ff upstream develop
To ensure consistency throughout the source code, keep these rules in mind as you are working:
Must be one of the following:
The subject contains succinct description of the change:
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.
(for contributors with push access)
Use the deploy script to automatically bump the package version number and publish to both github and npm.
npm run deploy