Skip to content

Latest commit

 

History

History
64 lines (36 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

64 lines (36 loc) · 2.47 KB

Contributing to TimeMap

First and foremost, thank you so much. We really appreciate you take the time to try and contribute and make TimeMap better for those who use it.

Contributing means many things

Contributing can indeed be about contributing code or creating an issue, but can also take many other forms, and this document is an attempt to describing what are all the possible ways in which you can contribute.

  • Updating or correcting documentation
  • Fixing an open issue
  • Requesting a feature
  • Reporting a bug

If you're new to this project, you could check the issues that are tagged "good first issue". These are generally those that are considered easy ways in.

Showing support for TimeMap

Please keep in mind that open source software is built by people like you, who spend their free time creating things the rest the community can use.

There are other ways in which you can contribute to the communal success of this project, such as starring the project on Github.

Getting Started

Issues

WIP

Before creating an issue

Try to follow these guidelines:

  • Investigate the issue: WIP
  • See if a ticket already exists: WIP
  • Ask the community: WIP
  • Proceed in creating your issue: WIP

Creating an issue

WIP

Pull Requests

Before making changes

WIP. Here we'll describe what the expected process and workflow is when making code changes, with regards to branching, forking and so on.

Submitting changes as Pull Requests

WIP

Additional resources

More information will be available on the git workflow wiki page.

You can also refer to Github's guide to forking a repository and to syncing a fork.

If you have any questions or just want to chat, please join our team fa_open_source on Keybase for community discussion. Keybase is a great platform for encrypted chat and file sharing.

Other

This contributing guide is based on the guidelines of the SuperCollider contributing guide.