Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.77 KB

How to contribute

Big Calendar loves to welcome your contributions. There are several ways to help out:

  • Create an issue on GitHub, if you have found a bug
  • Write test cases or provide examples for open bug issues. You can fork our Issue Template in codesandbox to get start.
  • Write patches for open bug/feature issues

There are a few guidelines that we need contributors to follow so that we have a chance of keeping on top of things.

Getting Started

  • Make sure you have a GitHub account.
  • Submit an issue, assuming one does not already exist.
    • Clearly describe the issue including steps to reproduce when it is a bug.
    • Make sure you fill in the earliest version that you know has the issue.
  • Fork the repository on GitHub.

Making Changes

  • Create a topic branch from where you want to base your work.
    • This is usually the master branch.
    • To quickly create a topic branch based on master; git branch master/my_contribution master then checkout the new branch with git checkout master/my_contribution. Better avoid working directly on the master branch, to avoid conflicts if you pull in updates from origin.
  • Make commits of logical units.
    • Write/change stories that showcase new features or props
    • Verify your changes against existing stories when necessary
  • Use descriptive commit messages following the Conventional Commit format and reference the #issue number.

Submitting Changes

  • Push your changes to a topic branch in your fork of the repository.
  • Submit a pull request to the repository