-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
21a7290
commit d1bc834
Showing
2 changed files
with
78 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # Code of Conduct | ||
|
|
||
| ## Introduction | ||
| We aim to create a welcoming, respectful, and inclusive environment for everyone participating in our project. Everyone participating in DSCI 524 group 31 activities is required to conform to the Code of Conduct. This Code of Conduct applies to all spaces managed by DSCI 524 group 31 including, but not limited to, group meetings, slack communication, and online forums such as GitHub. | ||
|
|
||
| The group members are responsible for enforcing this Code of Conduct. All reports will be reviewed by the members and will be kept confidential. | ||
|
|
||
| ## The DSCI 524 Group 31 Code of Conduct | ||
| We are dedicated to providing a welcoming and supportive environment for all people, regardless of background or identity. As such, we do not tolerate behaviour that is disrespectful to our teachers or learners or that excludes, intimidates, or causes discomfort to others. We do not tolerate discrimination or harassment based on characteristics that include, but are not limited to, gender identity and expression, sexual orientation, disability, physical appearance, body size, citizenship, nationality, ethnic or social origin, pregnancy, familial status, veteran status, genetic information, religion or belief (or lack thereof), membership of a national minority, property, age, education, socio-economic status, technical choices, and experience level. | ||
|
|
||
| Everyone participating in DSCI 524 group 31 activities is required to conform to the Code of Conduct. This Code of Conduct applies to all spaces managed by DSCI 524 group 31 including, but not limited to, group meetings, slack communication, and online forums such as GitHub. | ||
|
|
||
| ### Expected Behavior | ||
|
|
||
| All participants in our events and communications are expected to show respect and courtesy to others. All interactions should be professional regardless of platform: either online or in-person. In order to foster a positive and professional learning environment we encourage the following kinds of behaviours in all DSCI 524 group 31 projects and platforms: | ||
|
|
||
| - Use welcoming and inclusive language | ||
| - Be respectful of different viewpoints and experiences | ||
| - Gracefully accept constructive criticism | ||
| - Focus on what is best for the community | ||
| - Show courtesy and respect towards other community members | ||
|
|
||
| ### Unacceptable Behavior | ||
|
|
||
| Examples of unacceptable behavior by participants at any DSCI 524 group 31 event/platform include: | ||
|
|
||
| - written or verbal comments which have the effect of excluding people on the basis of membership of any specific group | ||
| - causing someone to fear for their safety, such as through stalking, following, or intimidation | ||
| - violent threats or language directed against another person | ||
| - the display of sexual or violent images | ||
| - unwelcome sexual attention | ||
| - nonconsensual or unwelcome physical contact | ||
| - sustained disruption of talks, events or communications | ||
| - insults or put downs | ||
| - sexist, racist, homophobic, transphobic, ableist, or exclusionary jokes | ||
| - excessive swearing | ||
| - incitement to violence, suicide, or self-harm | ||
| - continuing to initiate interaction (including photography or recording) with someone after being asked to stop publication of private communication without consent | ||
|
|
||
| ### Consequences of Unacceptable Behavior | ||
|
|
||
| Participants who are asked to stop any inappropriate behavior are expected to comply immediately. This applies to any DSCI 524 group 31 events and platforms, either online or in-person. If a participant engages in behavior that violates this code of conduct, the other group member may warn the offender and or engage the DSCI 524 Instructor to investigate the Code of Conduct violation and impose appropriate sanctions. | ||
|
|
||
| ### Incident Reporting Guidelines | ||
| If someone violates the Code of Conduct during a event or in an online space outside of organised events, we ask that you report it to the Instructor(s). The current instructor(s) of DSCI 524 is Daniel Chen. | ||
|
|
||
| ## Attribution | ||
| - Derived from the [Carpentries Code of Conduct](https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,55 @@ | ||
| # Contributing | ||
| # Contributing to project | ||
|
|
||
| Contributions are welcome, and they are greatly appreciated! Every little bit | ||
| helps, and credit will always be given. | ||
| Thank you for considering contributing to our project! We welcome all contributions that help make this project better for everyone. Please read this guide to understand how you can help and how to do so effectively. | ||
|
|
||
| ## Types of Contributions | ||
| ### Fixing typos | ||
|
|
||
| ### Report Bugs | ||
| 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. | ||
|
|
||
| If you are reporting a bug, please include: | ||
| - YES: you edit a roxygen comment in a `.R` file below `R/`. | ||
| - NO: you edit an `.Rd` file below `man/`. | ||
|
|
||
| * Your operating system name and version. | ||
| * Any details about your local setup that might be helpful in troubleshooting. | ||
| * Detailed steps to reproduce the bug. | ||
| ### Prerequisites | ||
|
|
||
| ### Fix Bugs | ||
| 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. If you've found a bug, create an associated issue and illustrate the bug with a minimal [reprex](https://www.tidyverse.org/help/#reprex). | ||
|
|
||
| Look through the GitHub issues for bugs. Anything tagged with "bug" and "help | ||
| wanted" is open to whoever wants to implement it. | ||
| ### Reporting Bugs | ||
|
|
||
| ### Implement Features | ||
| If you find a bug, please open an issue and include: | ||
|
|
||
| Look through the GitHub issues for features. Anything tagged with "enhancement" | ||
| and "help wanted" is open to whoever wants to implement it. | ||
| 1. A clear and descriptive title. | ||
|
|
||
| ### Write Documentation | ||
| 2. Steps to reproduce the problem. | ||
|
|
||
| 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. | ||
| 3. Expected vs. actual results. | ||
|
|
||
| ### Submit Feedback | ||
| 4. Screenshots, if applicable. | ||
|
|
||
| If you are proposing a feature: | ||
| 5. Information about your environment (e.g., OS, browser, or relevant tool versions). | ||
|
|
||
| * 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 :) | ||
| ### Suggesting Features | ||
|
|
||
| ## Get Started! | ||
| To suggest a feature or enhancement: | ||
|
|
||
| Ready to contribute? Here's how to set up `pyeda` for local development. | ||
| 1. Check existing issues to avoid duplicates. | ||
|
|
||
| 1. Download a copy of `pyeda` locally. | ||
| 2. Install `pyeda` using `poetry`: | ||
| 2. Open a new issue with the label `feature request`. | ||
|
|
||
| ```console | ||
| $ poetry install | ||
| ``` | ||
| 3. Include: | ||
|
|
||
| 3. Use `git` (or similar) to create a branch for local development and make your changes: | ||
| - A detailed description of the feature. | ||
|
|
||
| ```console | ||
| $ git checkout -b name-of-your-bugfix-or-feature | ||
| ``` | ||
| - Use cases and why it would be helpful. | ||
|
|
||
| 4. When you're done making changes, check that your changes conform to any code formatting requirements and pass any tests. | ||
| ### Pull request process | ||
|
|
||
| 5. Commit your changes and open a pull request. | ||
| - We recommend that you create a Git branch for each pull request (PR).\ | ||
| - New code should follow the tidyverse [style guide](http://style.tidyverse.org). You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR.\ | ||
| - We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation.\ | ||
| - We use [testthat](https://cran.r-project.org/package=testthat). Contributions with test cases included are easier to accept.\ | ||
|
|
||
| ## Pull Request Guidelines | ||
| ### Code of Conduct | ||
|
|
||
| Before you submit a pull request, check that it meets these guidelines: | ||
| Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. | ||
|
|
||
| 1. The pull request should include additional tests if appropriate. | ||
| 2. If the pull request adds functionality, the docs should be updated. | ||
| 3. The pull request should work for all currently supported operating systems and versions of Python. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| Please note that the `pyeda` project is released with a | ||
| Code of Conduct. By contributing to this project you agree to abide by its terms. | ||
| ### |