Skip to content

Latest commit

 

History

History
81 lines (48 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

81 lines (48 loc) · 3.09 KB

Contributing

Contributions are welcome, and greatly appreciated! Every little bit helps, and credit will always be given.

Read on if you want to learn about how our team contributes to our project's development (Internal Contributions) and how you can get involved (External Contributions).

Internal Contributions

Our team follows the GitHub Flow. This includes creating new branches to work on changes. When the changes are ready a pull request is made, accompanied by linked issues to facilitate discussion and review. After approval, the changes are merged to incorporate the new feature or fix to our project. Branches no longer in use are deleted to maintain a tidy repository.

External Contributions

Here are the different types of contributions you can make!

▸ Report Bugs

If you are reporting a bug, please open an issue and include:

  • A clear, yet concise, description of the bug, indicating details that would be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

▸ Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

▸ Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

▸ Submit Feedback

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope narrow, so its easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Here's how to set up for local development.

  1. Clone the repository locally. In your terminal run:

    $ git clone https://github.com/UBC-MDS/DSCI-532_2024_9_solar-savers.git

  2. Create and activate the conda environment. In the root of the repository run:

    $ conda env create --file environment.yml
    $ conda activate solar-saver

  3. Create a branch for local development and make your changes:

    $ git checkout -b name-of-your-fix-or-feature

  4. To run the dashboard, from the root of the directory (DSCI-532_2024_9_solar-savers) run:

    $ python -m src.app

  5. Click on the displayed link to open view the dashboard on a browser.

  6. When you're done making changes, check that your changes conform to any code formatting requirements.

  7. Commit and push your changes, then open a pull request with a detailed description outlining your contribution.

Code of Conduct

Please note that the Solar Savers project is released with a Code of Conduct. By contributing to the development of this project you agree to abide by its terms.

Attribution

This document was adpated from the eda_mds package, developed in DSCI 524 held in 2024, found here.