sidekik

sidekik

  • Docs
  • Contributing

›Contributing

Contributing

  • Contribution Guide
  • Codebase Overview
  • Package Codebase
  • Design Principles

Contribution Guide

First off, thanks for taking the time to contribute! Each contribution to the project is highly appreciated. Go through the guide to understand how we manage the repository. And how you can contribute.

Bugs

Where to Find Known Issues

We are using GitHub Issues for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist.

Reporting New Issues

Report bug issues with the bug issue template. The best way to get your bug fixed is to provide a reduced test case. Include a JSFiddle depicting the issue is a great starting point.

Proposing a Change

If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend filing an issue. This lets us reach an agreement on your proposal before you put significant effort into it.

If you're only fixing a bug, it's fine to submit a pull request right away but we still recommend to file an issue detailing what you're fixing. This is helpful in case we don't accept that specific fix but want to keep track of the issue.

Your First Pull Request

Working on your first Pull Request? You can learn how from this free video series:

How to Contribute to an Open Source Project on GitHub

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started.

If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.

If somebody claims an issue but doesn't follow up for more than two weeks, it's fine to take it over but you should still leave a comment.

Sending a Pull Request

The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation. We'll do our best to provide updates and feedback throughout the process.

Before submitting a pull request, please make sure the following is done:

  1. Fork the repository and create your branch from master.
  2. Run yarn in the repository root.
  3. If you've fixed a bug or added code that should be tested, add tests!
  4. Ensure the test suite passes (yarn test). Tip: yarn test --watch TestName is helpful in development.
  5. Format your code with prettier (yarn lint).
  6. Compile the TypeScript typechecks (yarn compile).

License

By contributing to Sidekik, you agree that your contributions will be licensed under its MIT license.

What Next?

Read the next section to learn how the codebase is organized.

Codebase Overview →
  • Bugs
    • Where to Find Known Issues
    • Reporting New Issues
  • Proposing a Change
  • Your First Pull Request
  • Sending a Pull Request
  • License
  • What Next?
Docs
Contributing
Community
GitterDiscord
More
GitHubStar
Sidekik
This project is licensed under the MIT License.