Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

38 lines (26 loc) · 1.93 KB
Raw

This file outlines how you can contribute to our Student Performance analysis for DSCI_522. We are happy to receive any feedback, bug reports, contributions, or examples to our analysis via DSCI 522 - Group 403 - Student Performance GitHub Repository.

Reporting Bug Issues

  1. Check if the bug has already been reported in a previous issue. If this bug has already been reported, please leave a comment on this issue instead of submitting a new one.

  2. If the bug has not been reported yet, please create an issue within this repository explicitly stating what the problem is, how to reproduce the problem, and how the behaviour of the bug deviates from the expected behaviour.

Setting up the GitHub Repository for Code Contributions

  1. Fork the repository (for more details see: GitHub Help)

  2. Clone the repository using:

git clone https://github.com/YOUR_USERNAME/DSCI_522-Group-403-Student-Performance.git
  1. To merge the clone with the original repository, use the following commands:
git remote add upstream https://github.com/UBC-MDS/DSCI_522-Group-403-Student-Performance.git
git fetch upstream
git merge upstream/master

Steps for a Pull Request

  1. First add your contribution to your forked repository using the following commands:
git add <your_input.R>
git commit -m 'Add input'
git push origin <branch-name>
  1. Submit a pull request on GitHub to merge your branch to the DSCI532_Group204_Vino master branch. For more details, see here: Creating a Pull Request.

Code of Conduct

All contributors to this project must follow the project's Code of Conduct. By participating in this project, you agree to the terms of this code of conduct.