Skip to content
This repository has been archived by the owner on Aug 19, 2020. It is now read-only.

Latest commit

 

History

History
37 lines (24 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.65 KB
Raw

Contributing

We will be happy to accept contributions to the FRESCO framework. Contributions could include:

  • Feedback - Whether you have a question on FRESCO, a suggestion for new additions or noticed a bug in the framework, any feedback is a valuable contribution.

  • Documentation - Any improvements or additions you may have to the documentation found on these pages are very welcome.

  • Code - We will be very happy to include well-written code that is compliant with the overall FRESCO design. This could be bug fixes, new protocol suites, generic functionality fitting the FRESCO standard library or improvements to the core framework etc.

We encourage you to use our issue tracker (https://github.com/aicis/fresco/issues) to provide feedback or discuss any other contributions you would like to make. Alternatively, you can contact us at [email protected].

Pull Requests

The easiest way to contribute code or documentation is to send us a pull request on GitHub. Please follow these steps:

  1. Create an issue related to your planned contribution on the issue tracker (https://github.com/aicis/fresco/issues).

  2. Create a fork of the FRESCO repository.

  3. Make your changes to the new fork.

  4. Make a Pull Request at GitHub.

Before being merged into the project your pull request will be reviewed by the FRESCO team. To ease this process, please keep your pull requests focused on the issue being solved. Also, please give the pull request an informative title and description, preferably with references to the issues related to the request (see https://help.github.com/articles/autolinked-references-and-urls/#issues-and-pull-requests).