CONTRIBUTING.md

Contributing to Charts

Thank you for your time!

Contributions

Thank you for considering contributing to Charts! The process includes the following steps before making any codebase changes:

• New issue: https://github.com/dautovicharis/Charts/issues
• Validate
• Assign the issue to developer
• Development time

Feel free to create an issue for any suggestions, improvement ideas, feature requests, or bug fixes. If you have any questions, please DM me: https://www.linkedin.com/in/dautovicharis/

Git setup

Fork repo

• Fork repository: https://github.com/dautovicharis/Charts
• Clone forked repository locally
• Add upstream

  git remote add upstream https://github.com/dautovicharis/Charts.git

Sync origin/main with upstream/main

 git fetch upstream
 git checkout main
 git merge upstream/main
 git push origin main

Prepare develop working copy

git checkout -b "develop" upstream/develop
git checkout develop
git push origin develop

Sync origin/develop with upstream/develop

git fetch upstream
git checkout develop
git merge upstream/develop
git push origin develop

Branch naming convention

bugfix/<bug-name>
feature/<feature-name>
improvement/<improvement-name>
update/<update-name>

Example:

bugfix/bar-chart-animation
bugfix/line-chart-shadow

feature/line-chart
feature/styles
feature/documentation

update/docs
update/dependencies

improvement/styles
improvement/app-demo

Commit

• Write in imperative mode: Start the line with 'Fix', 'Add', 'Update' instead of 'Fixed', 'Added', 'Updated'
• Capitalize the subject line

New branches

Create new branch from develop

PR

Create new PR to upstream/develop