Skip to content
This repository has been archived by the owner on Apr 26, 2018. It is now read-only.

Latest commit

 

History

History
68 lines (47 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

68 lines (47 loc) · 3.15 KB

Adding new features

This section includes advice on how to build new features for the project & what kind of process it includes.

  • This is how we like people to add new features:
    • Add only one feature at a time each on a new branch
  • Here are some specifics on the coding style we prefer:
    • Write the code test first
    • Document the code whether or not it is part of the public API
  • This is how you send your pull request:
    • TBD
  • You should include the following tests:
    • Unit tests (including tests for failure cases and testing exception paths) at a bare minimum
    • If creating a new chunk of code (rather than changing already existing code) include integration tests as well
  • These are the updates we hope you make to the changelog:
    • Create a header underneath the current version number with a brief description of the feature
    • Document any new command-line options

Don’t get discouraged! We estimate that the response time from the maintainers is around: One week, perhaps longer in December.

Bug triage

This section explains how bug triaging is done for your project. Help beginners by including examples to good bug reports and providing them questions they should look to answer.

  • You can help report bugs by filing them here: New Issue

  • You can look through the existing bugs here: Issues List

  • Look at existing bugs and help us understand if

    • The bug is reproducible? Is it reproducible in other environments (browsers)? What are the steps to reproduce?

  • You can close fixed bugs by testing old tickets to see if they are happening

  • You can update our change log here

  • You can remove duplicate bug reports

Translations

This section includes any instructions or translation needs your project has.

  • You can help us translate our project here:

Documentation

This section includes any help you need with the documentation and where it can be found. Code needs explanation, and sometimes those who know the code well have trouble explaining it to someone just getting into it.

  • Help us with documentation here

Community

This section includes ideas on how non-developers can help with the project. Here's a few examples:

  • You can help us answer questions our users have here:

  • You can help build and design our website here:

  • You can help write blog posts about the project by:

  • You can help with newsletters and internal communications by:

  • Create an example of the project in real world by building something or showing what others have built.

  • Write about other people’s projects based on this project. Show how it’s used in daily life. Take screenshots and make videos!

Your first bugfix

This section should help a person get started with their very first bug fix and thinking through the problem.

  • If you have further questions, contact:

This contributing file template is from contribute.md.