Skip to content

Commit

Permalink
Commit for initial release.
Browse files Browse the repository at this point in the history
  • Loading branch information
JordanRL committed Jul 5, 2021
1 parent 1b2afc8 commit 3f8ee22
Show file tree
Hide file tree
Showing 52 changed files with 4,968 additions and 1,159 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug report
about: Create a report to help us improve
title: 'Bug found in: [CLASS/METHOD/FILE]'
labels: Bug
assignees: JordanRL

---

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

**To Reproduce**
Steps to reproduce the behavior:
1. use this data to create a class
2. perform steps
3. Error or unexpected result

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

**PHP Version**
Provide the version of PHP that was producing this behavior

**Additional context**
Add any other context about the problem here. **If you have a proposed solution, reply after creating instead of adding it here.**
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
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: Feature Request
assignees: JordanRL

---

**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.
56 changes: 56 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name-template: 'v$RESOLVED_VERSION'
tag-template: 'v$RESOLVED_VERSION'
category-template: '### $TITLE'
categories:
- title: 'Features'
labels:
- 'Feature Request'
- title: 'Bug Fixes'
labels:
- 'Bug'
- title: 'Maintenance'
label:
- 'Code Quality'
- 'Performance'
- 'UX Improvement'
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
exclude-labels:
- 'PR: Skip Changelog'
version-resolver:
major:
labels:
- 'PR: Major'
minor:
labels:
- 'PR: Minor'
patch:
labels:
- 'PR: Patch'
default: patch
autolabeler:
- label: 'PR: Skip Changelog'
files:
- '*.md'
- '*.yml'
- label: 'PR: Major'
title:
- '/changed/i'
- label: 'PR: Minor'
title:
- '/added/i'
- '/updated/i'
- label: 'PR: Patch'
branch:
- '/bug-/i'
- '/b-/i'
- label: 'Bug'
title:
- '/fix/i'
branch:
- '/bug-/i'
- '/b-/i'
template: |
## Included In This Release
$CHANGES
19 changes: 19 additions & 0 deletions .github/workflows/pr-management.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Release Drafter

on:
push:
branches:
- master
pull_request:
types: [opened, reopened, synchronize]
branches:
- master

jobs:
update_release_draft:
runs-on: ubuntu-latest
steps:
- name: Release Drafter
uses: release-drafter/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Roster

## Installation

To install, simply require the package using composer:

composer require samsara/roster:^0.1

Or include it in your `composer.json` file:

```json
{
"require-dev": {
"samsara/roster": "^0.1"
}
}
```

The project namespace is `Samsara\Roster\*`. You can view the project on [Packagist](https://packagist.org/packages/samsara/roster).

## Documentation

After installing, from your project root on the command-line use:

php vendor/bin/roster [SOURCES_ROOT]

You can read the full documentation for Roster [here](https://jordanrl.github.io/Roster/).
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
"license": "GPL-3.0-only",
"require": {
"symfony/console": "^v5.3",
"samsara/mason": "dev-master"
"samsara/mason": "^0.1",
"php": ">=8.0"
},
"require-dev": {
},
Expand Down
Loading

0 comments on commit 3f8ee22

Please sign in to comment.