We'd love for you to contribute to our source code and to make angular-gantt better !
Source code is available on GitHub under the MIT License. You may also read Sources section to learn how to build angular-gantt from sources.
Here are the guidelines we'd like you to follow:
Before you submit your issue search the archive, maybe your question was already answered.
If you didn't found anything related in the archive, you can create a new issue providing:
- AngularJS version
- angular-gantt version
- Browser(s) used
- Long description of the issue
- Possible workaround
- Please configure your editor with formatting rules defined in
.editorconfigfile. You may find an EditorConfig plugin to automatically configure those settings.
- Try to follow convention used in existing sources.
- Use JSDoc to comment your code.
- Master branch:
masteris the main development branch. Each stable public version is tagged using this branch.
- Release branches:
MAJOR.MINOR.xare release branches. They contains minor changes and bugfixes after release of first major version. Only the latest release branch, and it won't contains new features from master branch and next releases.
- Feature branches: They contains code for a features or a bugfix which needs several commits, and will be merged when it is tested and ready.
Pull Request Guidelines
- Create and use a branch with a meaning full name, based on the
masterbranch for a new feature, or latest
MAJOR.MINOR.xbranch for a bugfix.
- Your pull request must contain only one feature or bugfix.
grunt watch --forceto build
angular-gantt.json the fly during development.
- Modify source files located in
- Files under
dist/are generated by the build.
- Keep only minimal changes for the feature or the fix.
- For a new feature, write a test by adding of modifying test files located in
- Run tests with
grunt test, and ensure all tests are passing.
- Update the demo application, and run it by running
- Build demo by running
- Create a Pull Request for your feature branch.
Git Commit Guidelines
This commit guidelines is inspired by angularJS project.
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 AngularJS change log.
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:
- feat: A new feature
- fix: A bug fix
- docs: Documentation only changes
- 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
- test: Adding missing tests
- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
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.
A detailed explanation can be found in this document.