X-Git-Url: https://git.p6c8.net/jirafeau_project.git/blobdiff_plain/9a9c9a8bf83241c193c5bef6361d41893e72dfd3..36e0d29e64f711ed170d431542cf62eeb42b96d7:/CONTRIBUTING.md?ds=inline diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94bdac5..0692922 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,7 @@ view only to show the most importants files and their role. ``` . ├── admin.php : administration interface to manage links and files +├── docker : folder containing some configuration files to run Jirafeau in docker ├── f.php : permits to download files or show the download page ├── index.php : provides a web interface to interact with API ├── script.php : API interface (all file actions happen here - upload, deletion, etc) @@ -45,10 +46,10 @@ view only to show the most importants files and their role. └── var-xxxxxxx : the users folder containing all data (auto generated, not versionized) ├── async : chunks of uploaded files (not succressfull yet) ├── files : all files that have been uploaded successfully - ├── [hashed file name] : the original file - ├── [hashed file name]_count : count many links to this file exist + │ ├── [hashed file name] : the original file + │ └── [hashed file name]_count : count many links to this file exist └── links : all links, including meta-informations, pointing to files - ├── [link] : the link file, includes which original file should be used and some meta data like creation date, expiration time + └── [link] : the link file, includes which original file should be used and some meta data like creation date, expiration time ``` ## Translations @@ -80,6 +81,8 @@ Quick walktrough: * Fork the original repository, clone the own repository, add the original repository as upstream * Checkout »next-release« branch ```git checkout next-release``` * Create a new branch on top of that one, e.g. »some-feature« ```git checkout -b some-feature``` +* Make your change +* You may check if the project is still [REUSE Compliant](https://reuse.software/) by running `docker run -v $(pwd):/code --rm fsfe/reuse /bin/sh -c "cd /code && reuse lint"` * Commit changes → push → send merge request ```git add -A; git commit; git push``` MR via GitLab (link shown in console) * Feature is reviewed * MR accepted: Reviewer checks out »next-release« branch and cherry-picks the commit ```git checkout next-release; git cherry-pick be4369641; git push``` @@ -87,11 +90,16 @@ Quick walktrough: ## New Releases +* If the release is not done for security purposes: create a new issue and freeze next-release branch for at least week. +* Make sure to run `php-cs-fixer fix --rules=@PSR2 .` and commit. * Compare the [»next-release« branch to »master«](https://gitlab.com/mojo42/Jirafeau/compare/master...next-release) -* Add a list of noteworthy features and bugfixes to the README +* Add a list of noteworthy features and bugfixes to `CHANGELOG.md` +* Add eventual upgrade procedure to `CHANGELOG.md` +* Build and test docker image * Change the version, using [semantic versioning](http://semver.org/), in ```settings.php``` * Merge »next-release« branch to »master« -* Update the demo page * Tag the »master« with the new version * Push branch and tag +* Push new docker image +* Update the demo page * Dance a little