Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

set up CODE_OF_CONDUCT.md CONTRIBUTING.md team-contract.md #1

Merged
merged 1 commit into from
Feb 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
* Violating UBC's Student Code of Conduct

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

If any of the contributors are found to violate the Code of Conduct, the team will report it to DSCI532 instructors (Florencia D'Andrea) and/or MDS Co-Directors (Varada Kolhatkar and Rodolfo Lourenzutti). Any contributor violating the code of conduct in any MDS forum, no matter if it's in the classroom, virtual meetings, or group work will be warned and expected to stop their inappropriate behavior. If they continue to engage in such behavior, we reserve the right to permanently ban them from contributing and engage with the MDS Co-Directors to investigate further and impose appropriate sanctions.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant homepage](http://contributor-covenant.org/version/1/4), version 1.4.
72 changes: 72 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Contributing to the citytemp Dashboard

Thank you in advance in making contribution to the dashboard. Any suggestions would be greatly appreciated!

## Contributors
* Eyre Hong
* Renne Kwon
* Sneha Sunil
* Vincent Ho

## Types of Contributions

Here, we list several ways in making contribution to this package.

### Fixing typos

Small typos or grammatical errors in documentation may be edited directly using
the GitHub web interface, so long as the changes are made in the _source_ file.

* YES: you edit a roxygen comment in a `.R` file below `R/`.
* NO: you edit an `.Rd` file below `man/`.

### Report Bugs

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.
* 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.

### Write Documentation

You can never have enough documentation! Please feel free to contribute to any
part of the documentation, such as the official docs, docstrings, or even
on the web in blog posts, articles, and such.

### Submit Feedback

If you are proposing a feature:

* Explain in detail how it would work.
* Keep the scope as narrow as possible, to make it easier to implement.
* Remember that this is a volunteer-driven project, and that contributions
are welcome.

## Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. Before you make a substantial pull request, you should always file an issue and
make sure someone from the team agrees that it's a problem.
2. The pull request should be created under a self branch if possible.
3. If the pull request relates to any of the functions in the package, the documentation should be updated as well.
4. The pull request should work for all currently supported operating systems and versions of Python.

## Code of Conduct

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

## Attribution
These contributing guidelines were adapted from the [dplyr contributing guidelines](https://github.com/tidyverse/dplyr/blob/master/.github/CONTRIBUTING.md).
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# netflix
# CityTemp Dashboard
34 changes: 34 additions & 0 deletions team-contract.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Project teamwork contract
*Course: UBC MDS DSCI 532 - Data Visualization II*

### Team Members
* Eyre Hong
* Renne Kwon
* Sneha Sunil
* Vincent Ho

## Expectations and Ground Rules

All group members will contribute their best efforts to ensure the project's success. We will endeavour to distribute the work evenly while taking into consideration each member's preferences and skillset. All members collectively hold the responsibility to ensure our deliverables are correct and complete, even if they did not personally work on them.

## Weekly Schedule & Deadlines
**Monday 2 PM - 6 PM** - Group meets to discuss the next milestone and divide the deliverables during the designated lab times. We may stay late to work out something complex together.
**Friday 6 PM** - Deadline for weekly deliverables.
**Saturday 12 - 6 PM** - Team members will check in remotely to merge our code, resolve any issues, and check over the final submission.

- Members should expect to spend upwards of an hour each Saturday afternoon finalizing our submission.

## Submission Details

Each team member will be responsible to do a submission for a milestone (in total 4 milestones). The team member who is responsible to do the submission should also take care of managing the GitHub repo. For example, open and close the issues, set up the project board and milestone deadlines etc.

## Communication and Conflict Management

All communication outside of the meetings will be through Github and Slack. GitHub will be the primary communication tool for ideas, suggestions, submitting work and reviewing work. We will manage deliverables through Github Issues, Milestones, and the GitHub Project. Slack will be the communication tool for informal communication and scheduling meetings.

## Breach of Contract
Failure to follow the team contract will result in a three-step warning system:
1. The first step is a written Slack notice that outlines the violation of the team contract and a reminder of the team contract conditions.
2. The second step is a meeting to discuss the behaviour and write an agreement to follow the team contract required by the member.
3. The third step is to reach out to the lab instructor or TAs about the issues with the teammate