Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 40 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,52 @@
# How to contribute
# How to Contribute

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

- Create an [issue](https://github.com/jquense/react-big-calendar/issues) on GitHub, if you have found a bug
- Write test cases or provide examples for open bug issues. You can fork our [Issue Template](https://codesandbox.io/s/react-big-calendar-example-v9wdyd) in codesandbox to get start.
- Write patches for open bug/feature issues
- Create an [issue](https://github.com/jquense/react-big-calendar/issues) on GitHub if you have found a bug.
- Write test cases or provide examples for open bug issues. You can start by forking our [Issue Template](https://codesandbox.io/s/react-big-calendar-example-v9wdyd) in CodeSandbox.
- 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.
To ensure efficiency and organization, we ask all contributors to follow a few guidelines.

## Getting Started

- Make sure you have a [GitHub account](https://github.com/signup/free).
- Submit an [issue](https://github.com/jquense/react-big-calendar/issues), 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.
1. **Create a GitHub Account**: Sign up at [GitHub](https://github.com/signup/free) if you don't already have an account.
2. **Report Issues**: [Check if the issue already exists](https://github.com/jquense/react-big-calendar/issues) before submitting a new one.
- Describe the issue in detail, including steps to reproduce if it is a bug.
- Include the earliest version that you know has the issue.
3. **Fork the Repository**: Make a personal fork of the repository on GitHub to start your work.

## 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 feat/my_contribution master` then checkout the new branch with `git checkout feat/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](https://www.conventionalcommits.org/en/v1.0.0/) format and reference the #issue number.
1. **Create a Topic Branch**: Base your work on the master branch. Create a new branch for your changes with `git branch feat/my_contribution master`, then switch to it with `git checkout feat/my_contribution`. It's best to avoid working directly on the master branch.
2. **Commit Logical Units**:
- Add or update `stories` to demonstrate new features or properties.
- Ensure your changes are compatible with existing `stories`.
3. **Commit Messages**: Follow the [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) format for your commit messages and include 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
1. **Push Changes**: Push your changes to your topic branch in your fork.
2. **Create a Pull Request (PR)**: Submit a PR to the main repository. Be sure to:
- Write a clear PR title and description detailing what your changes do and why they're needed.
- Link your PR to any relevant issues it addresses by following the [Conventional Commit ](https://www.conventionalcommits.org/en/v1.0.0/) format.

## Additional Guidelines

### Code of Conduct

We are committed to fostering a welcoming community. Please read our Code of Conduct before contributing to help us maintain a friendly and safe environment for everyone.

### First-Time Contributors

We love first-time contributors! If you're new to GitHub or open-source, here are some tips:
- Look for issues tagged with `good first issue`.
- Don't hesitate to ask for help or clarification in issue comments or our community chat.

### Community and Support

Join our [Slack channel](https://join.slack.com/t/bigcalendar/shared_invite/zt-2cerpqegz-mGzcbm7LxYLFPjcTa0gLgw) to ask questions, discuss features, or get help with your contributions. We're here to help!

### Documentation Contributions

Improvements to documentation are as valuable as code contributions. Whether it's fixing typos, clarifying instructions, or adding examples, all documentation updates are welcome.
Loading