-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Create CODE_OF_CONDUCT.md * Create CONTRIBUTING.md * Create bug_report.md * Create feature_request.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Create SECURITY.md * Create pull_request_template.md * Update pull_request_template.md * Update CONTRIBUTING.md
- Loading branch information
1 parent
d7ab620
commit d791d32
Showing
6 changed files
with
276 additions
and
0 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,38 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. iOS] | ||
- Browser [e.g. chrome, safari] | ||
- Version [e.g. 22] | ||
|
||
**Smartphone (please complete the following information):** | ||
- Device: [e.g. iPhone6] | ||
- OS: [e.g. iOS8.1] | ||
- Browser [e.g. stock browser, safari] | ||
- Version [e.g. 22] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
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,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
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,24 @@ | ||
# Pull Request Template | ||
<!--Thank you for contributing to MyClassroom! Please fill out this template before submitting your PR.--> | ||
|
||
## Screenshots | ||
<!--If applicable, add screenshots to help explain your problem or feature.--> | ||
|
||
## Description | ||
<!--Please include a summary of the change and which issue is fixed. Also, list any dependencies that are required for this change.--> | ||
|
||
Fixes # (issue) | ||
|
||
## Additional Information | ||
<!--Any additional information, configuration, or data that might be necessary to reproduce the issue.--> | ||
|
||
## Checklist: | ||
Before you submit your Pull Request, please make sure you have completed the following tasks: | ||
- [ ] I have performed a self-review of my own code. | ||
- [ ] I have commented my code, particularly in hard-to-understand areas. | ||
- [ ] I have made corresponding changes to the documentation. | ||
- [ ] My changes generate no new warnings. | ||
- [ ] I have added tests that prove my fix is effective or that my feature works. | ||
- [ ] New and existing unit tests pass locally with my changes. | ||
- [ ] Any dependent changes have been merged and published in downstream modules. | ||
- [ ] I have tagged my PR with the appropriate label(s). |
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,128 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, religion, or sexual identity | ||
and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
* Demonstrating empathy and kindness toward other people | ||
* Being respectful of differing opinions, viewpoints, and experiences | ||
* Giving and gracefully accepting constructive feedback | ||
* Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
* Focusing on what is best not just for us as individuals, but for the | ||
overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
* The use of sexualized language or imagery, and sexual attention or | ||
advances of any kind | ||
* Trolling, insulting or derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or email | ||
address, without their explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders 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, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at | ||
evan.thatcher@oregonstate.edu. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series | ||
of actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or | ||
permanent ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within | ||
the community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 2.0, available at | ||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
|
||
Community Impact Guidelines were inspired by [Mozilla's code of conduct | ||
enforcement ladder](https://github.com/mozilla/diversity). | ||
|
||
[homepage]: https://www.contributor-covenant.org | ||
|
||
For answers to common questions about this code of conduct, see the FAQ at | ||
https://www.contributor-covenant.org/faq. Translations are available at | ||
https://www.contributor-covenant.org/translations. |
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,49 @@ | ||
# Contributing to MyClassroom | ||
Thank you for your interest in contributing to MyClassroom! This document provides the guidelines for contributing to our GitHub repository. | ||
|
||
## Getting Started | ||
Before contributing, please ensure you have a GitHub account. To participate, you can fork the repository, push your contributions to your fork, and then submit a pull request (PR) to our project. | ||
|
||
### Creating Issues | ||
Before starting work on a feature, please create an issue detailing the problem you intend to solve or the feature you want to implement. This helps us track what's being worked on and discuss potential changes before they're implemented. | ||
|
||
#### Issue Templates | ||
- **Bug Report**: Use this template for reporting bugs. Include steps to reproduce, expected behavior, and any other relevant information. | ||
- **Feature Request**: Use this template to propose new features. Describe the problem your feature solves, your proposed solution, and any alternative solutions you've considered. | ||
|
||
#### Tracking Issues | ||
All issues are tracked in the MyClassroom [GitHub Project](https://github.com/orgs/OSU-MC/projects/1). Here, assignments, statuses, milestones, and timelines are managed to keep our development process smooth and transparent. | ||
|
||
### Branch/Tag Structure | ||
Our development process involves the following branch structure: | ||
- **Feature Branches:** All features should be developed on individual feature branches created from the `dev` branch. | ||
- **`dev` Branch:** Once a feature is complete, tested, and reviewed, submit a pull request to the `dev` branch. | ||
- **Tags:** Cumulative updates in the `dev` branch are considered for tagging into release versions, holding the stable release. | ||
|
||
### Working on Features | ||
1. Fork the repository. | ||
2. Create a new branch from `dev` for your feature. Branch name should be descriptive of the feature. | ||
3. Commit your changes. Write meaningful commit messages that explains what you've done and why. | ||
4. Push your changes to your fork. | ||
5. Submit a pull request from your feature branch to the `dev` branch. | ||
|
||
### Pull Requests | ||
- Ensure that your PR title and description are descriptive and concise. | ||
- Attach the PR to the related issue. | ||
- Reviews will be automatically requested from the appropriate team: | ||
- **Server (@OSU-MC/backend-team)**: All changes within the `/server/` directory. | ||
- **Client (@OSU-MC/frontend-team)**: All changes within the `/client/` directory. | ||
- **General (@OSU-MC/myclassroom)**: Changes in the parent directory or affecting multiple areas. | ||
- PRs will be reviewed according to the order they are received. Once approved, they can be merged into `dev` with the merge queue. | ||
|
||
### Code Review | ||
As an open source project, we welcome contributions from everyone. Here are some things you can do to make your contributions easier for others to review: | ||
- Keep your changes focused. If there are multiple changes you want to make, consider splitting them into separate PRs. | ||
- Write tests where possible and ensure existing tests pass. | ||
- Follow the coding standards and guidelines of the project. | ||
|
||
## Technologies | ||
- **Frontend:** React.js | ||
- **Backend:** Node.js | ||
|
||
Your contributions are vital to the success of MyClassroom, and we look forward to reviewing your innovative features and improvements. Let's create something amazing together! |
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,17 @@ | ||
# Security Policy | ||
## Supported Versions | ||
All tagged versions (`v0.x.x`) are currently pre-release and unsupported. Releases after `v1.0.0` will be considered stable and secure unless otherwise specified here or in release notes. | ||
|
||
<!-- | Version | Supported | | ||
| ------- | ------------------ | | ||
| 5.1.x | :white_check_mark: | | ||
| 5.0.x | :x: | | ||
| 4.0.x | :white_check_mark: | | ||
| < 4.0 | :x: | --> | ||
|
||
| Version | Supported | | ||
| ------- | ------------------ | | ||
| < 1.0.0 | :x: | | ||
|
||
## Reporting a Vulnerability | ||
Please create a GitHub Issue [here](https://github.com/OSU-MC/MyClassroom/issues) if you encounter any vulnerabilities (outside of dependancy updates). These are regularly checked and updated with statuses. If a stable release version has been tagged and a vulnerability issue goes unread, please reach out to the project maintainers. |