1.2 KB

Contributing to Surf

This document outlines the guidelines for contributing to the project.


The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

Bug Reports

A bug is a demonstrable problem that is caused by the code in the repository.

Guidelines for bug reports:

  1. Use the GitHub issue search - check if the issue has already been reported.

  2. Check if the issue has been fixed - try to reproduce it using the latest master or dev branch in the repository.

Feature Requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

IMPORTANT: By submitting a patch, you agree to allow the project owners to license your work under the terms of the MIT License.