-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #223 from Edirom/dev
Validation functionality in client and updates of node and dependency versions
- Loading branch information
Showing
23 changed files
with
7,719 additions
and
6,960 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,88 @@ | ||
# Want to contribute? | ||
|
||
That's awesome, thank you! | ||
|
||
The following is a set of guidelines for contributing to the webclient of MEIGarage. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. | ||
|
||
|
||
## I don't want to read this whole thing I just have a question!!! | ||
|
||
The best way to initially get in touch with the MEIGarage community is via the `mei-garage` [Slack channel] on music-encoding.slack.com. | ||
Or you can start a discussion here at [GitHub Discussions]. | ||
|
||
|
||
## Bug reports and feature requests | ||
|
||
If you've noticed a bug or have a feature request, please open a [GitHub issue] (well, you might want to look through the open issues before to avoid creating duplicates)! It's generally best if you get confirmation of your bug or approval for your feature request this way before starting to code. | ||
|
||
|
||
## Create a branch | ||
|
||
If this is something you think you can fix, then create a branch with a descriptive name, either in a [fork of this repo] (if it is clear that you will be the only one working on issue in the new branch), or in this repo directly. | ||
|
||
Please keep in mind that before coding along there should be a ticket for the task you want to accomplish. | ||
|
||
A good branch name would be (where issue #33 is the ticket you're working on): | ||
|
||
```sh | ||
git checkout -b issue-33 | ||
``` | ||
|
||
## Build and test your branch locally | ||
|
||
With [Docker installed] you simply tell it to build your locally checked out branch ("issue-33") with | ||
|
||
```sh | ||
docker build --tag vife-meigarage-webclient:issue-33 . | ||
``` | ||
|
||
and then you run it like | ||
|
||
```sh | ||
docker run --name vife-meigarage-webclient-issue-33 -p 8080:8080 -d vife-meigarage-webclient:issue-33 | ||
``` | ||
|
||
## Make a Pull Request | ||
|
||
If everything works as expected, you should switch back to your dev branch and make sure it's up to date with our dev (= our default) branch: | ||
```sh | ||
git remote add upstream [email protected]:edirom/vife-meigarage-webclient.git | ||
git checkout dev | ||
git pull upstream dev | ||
``` | ||
|
||
Then update your feature branch from your local copy of develop, and push it | ||
|
||
```sh | ||
git checkout issue-33 | ||
git rebase dev | ||
git push --set-upstream origin issue-33 | ||
``` | ||
|
||
Finally, go to GitHub and [make a Pull Request] | ||
|
||
## Merging a PR (maintainers only) | ||
|
||
A PR can only be merged into main by a maintainer if: | ||
|
||
* The branch is building ok on [DockerHub]. | ||
* It has been approved by at least two people. If it was a maintainer who opened the PR, only one extra approval is needed. | ||
* It has no requested changes. | ||
* It has no conflicts with current develop. (Even better: it is up to date with current develop) | ||
|
||
Any maintainer is allowed to merge a PR if all of these conditions are | ||
met. | ||
|
||
|
||
## Acknowledgements | ||
|
||
Large portions of these Contributing Guidelines were copied from [ActiveAdmin]. Thanks! | ||
|
||
[Slack channel]: https://music-encoding.slack.com/archives/C02RXAU582D | ||
[GitHub Discussions]: https://github.com/Edirom/vife-meigarage-webclient/discussions | ||
[GitHub issue]: https://github.com/Edirom/vife-meigarage-webclient/issues/new | ||
[fork this repo]: https://help.github.com/articles/fork-a-repo | ||
[Docker installed]: https://docs.docker.com/get-docker/ | ||
[make a pull request]: https://help.github.com/articles/creating-a-pull-request | ||
[ActiveAdmin]: https://github.com/activeadmin/activeadmin/blob/HEAD/CONTRIBUTING.md | ||
[DockerHub]: https://hub.docker.com/r/edirom/vife-meigarage-webclient |
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
Oops, something went wrong.