Skip to content

Commit

Permalink
chore: bump dependencies & update project-facing docs (#240)
Browse files Browse the repository at this point in the history
  • Loading branch information
paranarimasu authored Jul 6, 2021
1 parent 2942c6c commit a74490a
Show file tree
Hide file tree
Showing 6 changed files with 10,045 additions and 20,506 deletions.
52 changes: 23 additions & 29 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,46 @@
- [Assignment](#assignment)
- [Development Environment](#development-environment)
- [Feature Branch Workflow](#feature-branch-workflow)
- [Cleanup Before Pull Request](#cleanup-before-pull-request)
- [Pull Request](#pull-request)

## Assignment

Unless otherwise specified, any issue that does not have an assignee can be claimed by any volunteer.

Leave a comment in the issue indicating interest so that the assignee can be designated by a member. This is a requirement in Github to allow assignment of contributors outside of the organization by members.
Please leave a comment in the issue indicating interest so that you can be designated as the assignee by a member. This is a requirement in Github to allow asssignment of contributors outside of the organization by members.

If further discussion is needed before work can be started, please make use of the `#development` channel on the discord.
If further discussion is needed before work can be started, please make use of the `#design` channel on the discord.

## Development Environment

Follow the [Installation Guide](/AnimeThemes/animethemes-server/wiki/Installation) to ensure a functional local instance of AnimeThemes forked from this repository.
Ensure that you have a functional local instance of AnimeThemes forked from this repository by following the [Installation Guide](https://github.com/AnimeThemes/animethemes-server/wiki/Installation).

Enable the forked repository in [StyleCI](https://styleci.io/) so that code styling guidelines are followed. At the time of writing, analysis is run on push and merge.
Enable your repository in [StyleCI](https://styleci.io/) so that code styling guidelines are followed. At the time of writing, analysis is run on push and merge.

Set this repository as upstream to the forked repository.
Set this repository as upstream to your fork.

`git remote add upstream https://github.com/AnimeThemes/animethemes-server.git`

Check out release branch. At the time of writing, the release branch is named `wiki`.
Checkout release branch.

`git checkout wiki`
`git checkout release-branch`

Pull upstream changes so that the local wiki branch is even with the upstream wiki branch.
Pull upstream changes so that your local branch is even with upstream.

`git pull upstream wiki`
`git pull upstream release-branch`

Push upstream changes to the forked remote wiki branch if needed.
Push upstream changes to your remote if needed.

`git push`

## Feature Branch Workflow

Once the release branch is even with upstream, create a new feature branch from the release branch. The new feature branch name should be descriptive.
Once your release branch is even with upstream, create feature branch from release branch.

`git branch new-feature-branch`

Switch to the new feature branch.
Switch to feature branch.

`git checkout new-feature-branch`

Make changes in the new feature branch. Once completed, run tests.
Make changes in feature branch. Once completed, run tests.

`php artisan config:clear && php artisan test --parallel`
`php artisan config:clear && php artisan test`

Execute static code analysis.

Expand All @@ -56,17 +50,17 @@ Stage changes. Commit changes. Please include ticket ID's and use [Semantic Comm

## Cleanup Before Pull Request

Fetch the upstream release branch and merge with the fork repo's release branch.
Fetch upstream master and merge with your repo's master branch
```
git fetch upstream wiki
git checkout wiki
git merge upstream/wiki
git fetch upstream release-branch
git checkout release-branch
git merge upstream/release-branch
```

If there were any new commits, rebase the new feature branch.
If there were any new commits, rebase your development branch
```
git checkout new-feature-branch
git rebase wiki
git rebase release-branch
```

## Pull Request
Expand All @@ -77,7 +71,7 @@ Push changes to remote.

Confirm StyleCI passing status on push.

Create Pull Request from the new feature branch to the upstream release branch.
Create Pull Request from your new feature branch to upstream release branch.

## Pruning

Expand All @@ -89,11 +83,11 @@ Delete the remote feature branch.

`git push origin --delete new-feature-branch`

Pull upstream changes so that the fork release branch is even with upstream.
Pull upstream changes so that your local branch is even with upstream.

`git pull upstream release-branch`

Push upstream changes to the fork's remote if needed.
Push upstream changes to your remote if needed.

`git push`

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 AnimeThemes
Copyright (c) AnimeThemes

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@
<a href="https://twitter.com/AnimeThemesMoe"><img src="https://img.shields.io/twitter/follow/AnimeThemesMoe?style=social"></a>
</p>

[**AnimeThemes**](https://animethemes.moe/) is a simple and consistent repository of anime opening and ending themes. We provide direct links to high quality WebMs of your favorite OPs and EDs for your listening and discussion needs.

This is the repository for the server application that is responsible for AnimeThemes.moe resource management, API, and other services related to serving the AnimeThemes database.

# Staff
## Installation

Please review the [**Installation Guide**](https://github.com/AnimeThemes/animethemes-server/wiki/Installation) in the wiki for detailed instructions.

## Contributing

* paranarimasu ([Github](https://github.com/paranarimasu))
* ProWeebDev ([Github](https://github.com/ProWeebDev))
* Gaporigo ([Github](https://github.com/Gaporigo))
Please review the [**Contributing Guide**](https://github.com/AnimeThemes/animethemes-server/wiki/Contributing) in the wiki for detailed instructions.

# Installation
## Resources

Please review the [Installation Guide](https://github.com/AnimeThemes/animethemes-server/wiki/Installation) in the wiki for detailed instructions.
Please make use of the #development channel in the [**Discord Server**](https://discordapp.com/invite/m9zbVyQ) for questions pertaining to the AnimeThemes database or API.
Loading

0 comments on commit a74490a

Please sign in to comment.