Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

68 lines (49 loc) · 3.04 KB

Introduction

How to contribute to Rexchain

First off, thank you for considering contributing to Rexchain.
Feel welcome and read the following sections in order to know how to ask questions and how to work on something.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

As for everything else in the project, the contributions to Rexchain are governed by our Code of Conduct.

Support questions

Please, don't use the issue tracker for this. You can contact us at [email protected] we will anwser back as soon as we can.

Reporting issues

Report bugs at https://github.com/Prescrypto/RexChain/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • If you can, provide detailed steps to reproduce the bug.
  • If you don't have steps to reproduce the bug, just note your observations in as much detail as you can. Questions to start a discussion about the issue are welcome.

Submitting patches

Please use Flake8 to check your code style. You may also wish to use Black's Editor integration. Include tests if your patch is supposed to solve a bug, and explain clearly under which circumstances the bug happens. Make sure the test fails without your patch. Include a string like "Fixes #543" in your commit message (where 543 is the issue you fixed). See Closing issues using keywords.

Submiting new features

Please open a new issue about the feature you want to propose prior to submitting a PR so it can be discussed.

TODO list:

  • Implement search endpoints specific payload data fields (ie: medic, patient, etc.)

First time setup

Download and install the latest version of git.

Configure git with your username and email:

git config --global user.name 'your name'
git config --global user.email 'your email'

Make sure you have a GitHub account.

Fork Rexchain to your GitHub account by clicking the Fork button.

Clone your GitHub fork locally:
git clone https://github.com/{username}/Rexchain
cd rexchain

Add the main repository as a remote to update later:
git remote add Prescrypto https://github.com/Prescrypto/RexChain git fetch prescrypto

Create a vagrant machine:
# inside the directory run the vagrantfile
$ vagrant up
# get server running and start creating stuff
$ vagrant ssh

$ cd /vagrant/rexchain
$ python3.6 manage.py migrate
$ python3.6 manage.py loaddata ./fixtures/initial_data.json
$ python3.6 manage.py runserver [::]:8000

# Wake Up Redis Worker
# Open a new window console enter to ssh of vagrant and run these commands
$ cd /vagrant/rexchain
$ python3.6 manage.py rqworker high default low