Skip to content

Commit

Permalink
Merge pull request #23 from talview/release/v1.1.0
Browse files Browse the repository at this point in the history
Release/v1.1.0
  • Loading branch information
rakeshprabhu authored Aug 22, 2023
2 parents 5641988 + 6700f9e commit 4c09282
Show file tree
Hide file tree
Showing 17 changed files with 1,093 additions and 68 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @rakeshprabhu @harish-talview @merlano17 @devang1281 @manquer @KeerthiHarish
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug Report
about: Create a report to help us improve
labels: Bug
---

## Description

**Current behavior**
A clear and concise description of what the bug is.

**Expected behavior**
A clear and concise description of what you expected to happen.

## Steps to reproduce

Steps to reproduce the behavior:

(Add link to a demo if possible)

**Screenshots**
If applicable, add screenshots to help explain your problem.

## Versions

- Moodle:
- Plugin:
- Browser:
- OS:
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project
labels: Feature
---

**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.
22 changes: 22 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Description
- Please include a summary of the change.

## Github Issue
- Add github issue link and title (eg: resolves #123)

## Checklist before requesting a review
- [ ] One line description of the changes is added in the PR
- [ ] Issue is linked to the PR via commits (eg: resolves #123)

## Type of change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires only a documentation update

## Dependencies (if any):
- Mention any dependencies/issues for reviewers reference (eg: #1124 needs to be deployed before/after this PR)

## References (if any):
- [ ] Any reference documents to review before/after this PR review
- Add the links of any related PR/documents/diagrams for reviewers reference (eg: #link to understand login flow).
4 changes: 3 additions & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,18 @@ jobs:
git archive --prefix=proctor/ -o proctor.zip $stashName
git rm --cache -r vendor
- name: Create Release
if: github.event_name != 'pull_request'
id: create_release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ github.ref }}
tag_name: ${{ github.ref }}-Quiz_Access_Proctor
release_name: Release ${{ github.ref }}
draft: false
prerelease: false
- name: Upload Release Asset
if: github.event_name != 'pull_request'
id: upload-release-asset
uses: actions/upload-release-asset@v1
env:
Expand Down
135 changes: 135 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
# 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, caste, color, 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 https://talview.freshdesk.com/support/home.
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.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org

[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

[Mozilla CoC]: https://github.com/mozilla/diversity

[FAQ]: https://www.contributor-covenant.org/faq

[translations]: https://www.contributor-covenant.org/translations
96 changes: 96 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# Contributing to Proview - Moodle (Quizaccess-Proctor) Plugin

Welcome to the Proview - Moodle (quizaccess_proctor) Plugin project! We appreciate your interest in contributing.
This document
outlines the guidelines for contributing to this project. By participating, you agree to follow these guidelines and
contribute in a positive and respectful manner.

## Table of Contents

- [How Can You Contribute?](#how-can-you-contribute)
- [Getting Started](#getting-started)
- [Fork the Repository](#fork-the-repository)
- [Clone Your Fork](#clone-your-fork)
- [Making Changes](#making-changes)
- [Create a Branch](#create-a-branch)
- [Make Your Changes](#make-your-changes)
- [Commit Your Changes](#commit-your-changes)
- [Push Your Changes](#push-your-changes)
- [Submit a Pull Request](#submit-a-pull-request)
- [Code of Conduct](#code-of-conduct)

## How Can You Contribute?

You can contribute to the Proview - Moodle Plugin in the following ways:

- Reporting issues or bugs on the [Issue tracker](https://github.com/talview/moodle-quizaccess_proctor/issues)
- Suggesting new features or enhancements
- Improving documentation
- Writing code improvements or fixes
- Reviewing and providing feedback on pull requests

## Getting Started

### Fork the Repository

Fork the Plugin repository to your GitHub account by clicking the "Fork" button at the top of the
repository page.

### Clone Your Fork

Clone your forked repository to your local machine:

```sh
git clone https://github.com/talview/moodle-quizaccess_proctor.git
cd moodle-quizaccess_proctor
```

## Making Changes

### Create a Branch

Create a new branch for your changes:

```sh
git checkout -b your-feature-branch
```

### Make Your Changes

Make your desired changes to the codebase.

### Commit Your Changes

After making changes, commit them with a descriptive commit message:

```sh
git add .
git commit -m "Add a brief description of your changes"
```

### Push Your Changes

Push your changes to your forked repository:

```sh
git push origin your-feature-branch
```

## Submit a Pull Request

1. Go to the original repository's [Pull Requests](https://github.com/talview/moodle-quizaccess_proctor/pulls) page.
2. Click on "New Pull Request."
3. Select your forked repository and the branch with your changes.
4. Provide a descriptive title and detailed description of your pull request.
5. Click "Create Pull Request."

Your pull request will be reviewed by project maintainers, and feedback or changes may be requested.

## Code of Conduct

Please note that all contributors are expected to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). By participating,
you are agreeing to
uphold this code of conduct and treat all participants with respect.

Thank you for your interest in contributing to the Talview Proview Moodle Plugin! Your contributions help make this
project better.
Loading

0 comments on commit 4c09282

Please sign in to comment.