Skip to content
This repository has been archived by the owner on Sep 12, 2023. It is now read-only.

Latest commit

 

History

History
50 lines (29 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

50 lines (29 loc) · 3.44 KB

We welcome all contributions to this project! If you notice a bug or have a feature request, please open up an issue. All contributors must abide by our code of conduct.

Are you a developer and interested to contribute to our project?

Our primary goal is to support BC surgical system and while the app is aimed at BC administrators. Recognizing that for the community, your contributions to us are very important. If you would like to contribute to this project and make it better, your help is extremely welcome. By supporting the professional development of any and all of our contributors, we're thrilled to patch another hole in the leaky pipeline. This is a fantastic chance for you if you want to learn to code, collaborate with others, gain experience writing grant applications, or apply your abilities to the digital arena. If you think you can help in any part of this project please feel free to send us a pull request. How to make a clean pull request please refer to the steps below.

Please keep in mind that maintaining a good and supportive environment for everyone who wishes to join is also important to us. When you join us, we expect you to adhere to our code of conduct.

How to make a clean pull request

  • Create a personal fork of the project on Github.
  • Clone the fork on your local machine. Your remote repo on Github is called origin.
  • Add the original repository as a remote called upstream.
  • If you created your fork a while ago be sure to pull upstream changes into your local repository.
  • Create a new branch to work on! Branch from develop if it exists, else from master.
  • Implement/fix your feature, comment your code.
  • Follow the code style of the project, including indentation.
  • Write or adapt tests as needed.
  • Add or change the documentation as needed.
  • Push your branch to your fork on Github, the remote origin.
  • From your fork open a pull request in the correct branch. Target the project's develop branch if there is one, else go for master!
  • Once the pull request is approved and merged you can pull the changes from upstream to your local repo and delete your extra branch(es).

Installation instructions

Package dependencies can be installed using pip or conda. Make sure you installed python and pip/conda using this Instruction Guidlines. In order to install this dashboard app and run in your local computer, please follow these steps:

1.-Open a terminal in your local computer, navigate to a location you desired using cd path and clone our project from this Github repository using command:

git clone https://github.com/ubco-mds-2021-labs/dashboard1-group-f.git

2.-In the terminal, navigate to the project directory using cd path and run the following command, please note if there is any package dependency missing please install using pip install package_name:

python app.py

3.-Copy the link from the terminal localhost and enter to your web browser to view the dash app.

Contact us

We'd love to hear from you if you have a problem or a suggestion for improvement; just open an issue on this github repository and we'll take care of it straight away.

We are very thankful for any of your contributions to this project!