Skip to content

Latest commit

 

History

History
84 lines (50 loc) · 4.52 KB

CONTRIBUTING.md

File metadata and controls

84 lines (50 loc) · 4.52 KB
Raw

Contributor Guide

Hello there!

There are many ways in which you can contribute to Folktale, and this document provides guidelines for the social and technical aspects that come into play for most contributions to the project.

Do note that people are expected to follow Origami Tower's Code of Conduct. This code of conduct applies to all interactions in the project, be them when discussing issues on GitHub, asking or providing support in the Gitter channel, or any other social interaction involving Folktale.

Harassment of any form will not be tolerated. If you are being harassed, please contact us immediately so that we can support you.

Table of Contents

How can I contribute to Folktale?

Here are some ways in which you can contribute to the Folktale community:

  • Join the Gitter Channel and ask and/or answer questions. Folktale aims to be usable by people new to FP, so by asking questions and sharing your troubles with the library, you're helping us get closer to that goal.

  • Talk about Folktale. By bloggging, writing tutorials, or giving talks in your local JS community. A bigger and healthy community helps by really putting the libraries to test.

  • Report bugs in our GitHub issue tracker, or request new features.

  • Submit patches for new features, or to fix existing bugs. Take a look at the list of Good First Issues if you're not entirely sure where to start.

  • Improve existing documentation.

Reporting bugs

Sometimes things don’t work as well as they should, or we can’t make them work the way we want, and we get frustrated by that. Both of those are situations were we encourage you to open an issue in the GitHub issue tracker so we can help you. Read the Bug Reporting guide for more details.

Requesting features

Folktale doesn’t do everything, so more often than not you’ll find something that you wish Folktale supported but that isn’t implemented yet. Maybe the thought has never crossed our minds. This is a great opportunity to tell us about that feature you want.

Adding or fixing tests

Folktale uses Mocha and JSVerify for tests. Read the Test Writing guide to understand how to add new tests, or update existing ones.

Adding or fixing documentation

Found a typo in the documentation, or think that something is missing from it, and want to help fixing that? Read the Documentation Writing guide to understand how.

Contributing bugfixes

While we do our best to write correct software, sometimes bugs will escape our tests and creep in. We really appreciate any contribution to fix these issues. Read the Bug Fixing guide to understand how to contribute.

Adding new features

Folktale has a roadmap which summarises the vision for the future of the library. Points in this roadmap are broken down into features, and detailed on the issue tracker as a feature proposal. The Contributing Features guide describes the process of contributing a new feature to Folktale.

Important If a feature is not in the roadmap, please submit a feature request explaining why it should be added before you start to work on it.