Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 2.7 KB

contributing.md

File metadata and controls

55 lines (33 loc) · 2.7 KB
Raw

CONTRIBUTING

Contributing to Tutim

Thank you for showing an interest in contributing to Tutim!

All kinds of contributions are valuable to us. In this guide, we will cover how you can quickly onboard and make your first contribution.

Submitting an issue

You can open a new issue with this issue form.

While we want to fix all the issues, before fixing a bug we need to be able to reproduce and confirm it. Please provide us with a minimal reproduction scenario using a repository or Gist. Having a live, reproducible scenario gives us the information without asking questions back & forth with additional questions like:

  • 3rd-party libraries being used and their versions
  • a use-case that fails

Without said minimal reproduction, we won't be able to investigate all issues, and the issue might not be resolved.

Pull Request

We encourage contributions to Tutim's open-source codebase! When contributing, consider first discussing your desired change with our team via GitHub issues or Discord.

When you feel ready, you can compare the 2 branches to discuss and review changes through the New Pull Request

Missing a Feature?

If a feature is missing, you can directly request a new one here. You also can do the same by choosing "🚀 Feature" when raising a New Issue on our GitHub Repository. If you would like to implement it, an issue with your proposal must be submitted first, to be sure that we can use it. Please consider the guidelines given below.

Coding guidelines

To ensure consistency throughout the source code, please keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more specs (unit-tests).
  • We use Eslint default rule guide, with minor changes. An automated formatter is available using prettier.

Need help? Questions and suggestions

Questions, suggestions, and thoughts are most welcome. Feel free to open a GitHub Discussion. We can also be reached on our Discord Server.

Ways to contribute

  • Try the Tutim API and platform and give feedback
  • Tell your friends and tag us on Twitter @tutim-io
  • Add new input types and validations
  • Share the community with your use cases
  • Help with open issues
  • Share your thoughts and suggestions with us
  • Request a feature by submitting a proposal
  • Report a bug
  • Improve documentation - fix incomplete or missing docs, bad wording, examples, or explanations.

Missing an input type or validation?

If you are in need of a provider we do not yet have, you can request a new one by submitting an issue. Or you can build a new one by following our "create a new input type or validation" guide.