CONTRIBUTION.md

Contributing to Tabler

🎉🎉 Welcome and thanks for contributing to Tabler! 🎉🎉

The following is a set of guidelines for contributing to the angular fork of tabler. Please feel free to initiate conversation about changes you'd want considered through a pull request before they are merged into the master branch. We welcome contributions that improve documentation, triage and fix bugs as well as add or improve dashboard components. Are you currently using tabler in a project? You are welcome to share it on the slack channel.

Please, don't use the issue tracker for [support questions]. Check whether the slack channel can help with your issue.

Ground Rules

The tabler project ascribes to the contributor convenent code of code.

Contribution Guidelines

Please feel free to file build, runtime and documentation issues at https://github.com/tabler/tabler-angular/issues.

Before contributing changes, you can setup your fork(copy of repo) as follows:

1. Fork https://github.com/tabler/tabler-angular.git into your own GitHub account
2. Clone your fork: git clone [email protected]:<your_username_here>/tabler-angular.git
3. In command line, cd tabler-angular
4. Setup 'connection' to main repo: git remote add upstream https://github.com/tabler/tabler-angular.git

To submit changes:

1. Sync your fork with upstream main repo: git fetch upstream
2. Create your fix branch: git checkout upstream/master -b name_of_your_branch
3. Make your changes
4. Add your changes git add .
5. Commit your changes git commit -a -m "<your informative commit message>"
6. Push your changes to your remote fork: git push origin name_of_your_branch

To send a pull request (request your changes be merged into main repo):

1. Go to https://github.com/tabler/tabler-angular.git and click the "Compare & pull request" button
2. Tag the relevant people and GitHub issue (if any)