Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 2.89 KB
Raw

Introduction

Thank you for considering contributing to Ticketbooth. We welcome contibutions from anyone who wants to make this project great! Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

There are many ways you can contribute, including writing documentation, submitting bug reports, suggesting new features and improvements, or writing code.

Guidelines

Any contributions to Ticketbooth must abide by these criteria:

  • Ticketbooth only supports blockchains based on the Stratis full node. If you wish to port Ticketbooth to another blockchain, feel free to fork it.
  • Overall gas fees for all parties should be minimised where possible.
  • Personal data cannot be publicly accessible on the blockchain and must only be accessible by the parties necessary for Ticketbooth to function.
  • Features are not developed to work with a specific closed source platform. If you wish to develop a specific feature, again, feel free to fork it.

If you become aware of any possibility of violation to these criteria, please create an issue.

Your First Contribution

Any issues labelled good-first-issue are the best to start off with, as they should be quite simple and not require many changes. Issues that are labelled as help-wanted are perfect for getting involved in discussion.

Getting Started

To contribute to Ticketbooth, follow these steps:

  1. File an issue (if an associated issue isn't already created)
  2. For a large change, wait to receive feedback to make sure that the issue is within the scope of Ticketbooth
  3. Fork the project
  4. Do the changes in your own fork
  5. Submit a pull request, making sure to have written tests where they are benefitial, and to have followed the code style of the project

Small or non-critical changes, such as documentation changes, layout improvements and fixing of typos are welcomed and do not need to have an issue filed against them.

How to Report a Bug

If you find a security vulnerability, do NOT open an issue. Email adam.shirt@developmomentum.com instead. Please give an explanation as to how the vunerability can be exploited. For non-critical bugs, create an issue and provide the following information:

  • The project the bug is related to
  • Steps to reproduce
  • Expected behaviour
  • Actual behaviour

How to Suggest a Feature or Enhancement

Ticketbooth is designed to provide a smart contract solution to the event ticketing industry, with the use of Stratis platform. All features of Ticketbooth must be developed in the best interest of the customer.

When suggesting a feature, please give a detailed explanation of what you wish Ticketbooth to include and how you believe it should work.

Code Review Process

Contributions are reviewed by maintainers of Ticketbooth and should be first reviewed within 7 days. Any feedback is then expected to be acted upon for the pull request to be merged.