Skip to content

Latest commit

 

History

History
78 lines (44 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

78 lines (44 loc) · 3.04 KB
Raw

alt text

#Contributing Guide


## Introduction =======

Anybody can contribute to Fermat and you are welcome to do so. There is a stable community of mantainers called bitDubai. You might want to join this community and specifically one of their teams which are working on different areas of the system. Visit their site to learn how to join in.

Also, you might want to add your own functionality to Fermat, perhaps your own platform, plugins, reference wallet or build your own niche wallet. To help you get all the necessary tools to set up the development enviroment, please refer to Installation Guide

Part I: Casual Contribution

We consider a casual contribution a bug fix or any other change big or small done in casual way, without assuming any responsability for the maintenance of the code submited. Casual contributions don't get to the size of adding new components to the system.


### Contributing to a Component

Whatever you may find that could make Fermat better is welcome and it will be considered. Follow these steps to find the best way for your case:

In fermat, every component (plug-in, add-on, library, etc) has an Author and a maintainer.

  1. Open www.fermat.org, go to the Architecture view and zoom in until you find the component you will suggest to change.
  2. Click on that component to select it.
  3. You will find there a picture of the author. If he/she is not the current maintainer, you will also find the maintainers picture.
  4. Click again their the picture to get more detailed info including their github username.
  5. Go to https://github.com/*username*/fermat.

If your change doesn't need to be compiled and tested or you prefer not to do that yourself, then you can go through the Casual or Minor Change section. Otherwise, if you prefer to get deeper and finish the job yourself, then go throught the Major Change section.

Casual or Minor Change

Find the file in username/fermat repo, open it on edit mode and hit the "Propose file change" button when you are done.

Major Change

Fork the username/fermat repo, and submit a pull request there when done.


### Contributing to the Fermat Book

It is very easy to contribute to the book, just edit the desired file and at the end you will find the "Propose file change" button. Please do it at the editors' fork. You can find it here.


## Part II: Expanding Fermat Functionality
### Expanding the Master Plan
### Adding a New Platform
### Adding a New Add-on
### Adding a New Plug-in

For the details on this process, you can check the Adding a New Plug-in to Fermat document.


### Adding a New Reference Wallet
### Adding a New Niche Wallet
### Creating a Branded Wallet