From e3f15bee19b724694d06ca6eed9a3b70453c8314 Mon Sep 17 00:00:00 2001 From: Mathieu ANCELIN Date: Mon, 2 Dec 2019 14:32:35 +0100 Subject: [PATCH] Update contributin --- .github/CONTRIBUTING.md | 18 +++++++---- .github/ISSUE_TEMPLATE.md | 38 ------------------------ .github/PULL_REQUEST_TEMPLATE.md | 51 -------------------------------- scripts/build.sh | 11 +++++-- 4 files changed, 22 insertions(+), 96 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a3d2f7adf..c9e6ae076 100755 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,12 +2,14 @@ These guidelines apply to all Daikoku projects living in the the `MAIF/daikoku` repository. -These guidelines are meant to be a living document that should be changed and adapted as needed. -We encourage changes that make it easier to achieve our goals in an efficient way. - ## Codebase -explain the layout of your repo. +* [demo](https://github.com/MAIF/daikoku/demo): contains the demos +* [docs](https://github.com/MAIF/daikoku/docs): contains the Daikoki website, avoid modification as its generated +* [manual](https://github.com/MAIF/daikoku/manual): the Daikoku user manual that will be generated with [Paradox](https://github.com/lightbend/paradox) +* [daikoku](https://github.com/MAIF/daikoku/daikoku): the daikoku app +* [resources](https://github.com/MAIF/daikoku/resources): various static resources +* [scripts](https://github.com/MAIF/daikoku/scripts): various scripts used by Travis and devs ## Workflow @@ -62,7 +64,13 @@ You must add the dependency and its licence in https://github.com/MAIF/daikoku/b if you add features to Daikoku, don't forget to modify the user documentation -* https://github.com/MAIF/daikoku/tree/master/docs/documentation +* https://github.com/MAIF/daikoku/tree/master/docs/manual + +to build the documentation, run the following command at the root of the repository + +```sh +sh ./scripts/build.sh manual +``` ## Tests diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 272cbd708..e69de29bb 100755 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2ae747275..e69de29bb 100755 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,51 +0,0 @@ ---- -name: Pull request -about: Add feature 1 -title: '' -labels: '' -assignees: '' - ---- - -## Status -**READY/IN DEVELOPMENT/HOLD** - -## Migrations -YES | NO - -## Description -A few sentences describing the overall goals of the pull request's commits. - -## Related PRs -List related PRs against other branches: - -branch | PR ------- | ------ -other_pr_production | [link]() -other_pr_master | [link]() - - -## Todos -- [ ] Tests -- [ ] Documentation - - -## Deploy Notes -Notes regarding deployment the contained body of work. These should note any -db migrations, etc. - -## Steps to Test or Reproduce -Outline the steps to test or reproduce the PR here. - -```sh -git pull --prune -git checkout -bundle; script/server -``` - -1. - -## Impacted Areas in Application -List general components of the application that this PR will affect: - -* \ No newline at end of file diff --git a/scripts/build.sh b/scripts/build.sh index 0d669e678..3888d86d7 100644 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -3,13 +3,13 @@ LOCATION=`pwd` clean () { - rm -rf $LOCATION/docs/manual cd $LOCATION/daikoku/ rm -rf ./target/universal sbt 'docker:clean' } build_manual () { + rm -rf $LOCATION/docs/manual cd $LOCATION/manual node indexer.js sbt ';clean;paradox' @@ -104,8 +104,15 @@ case "${1}" in test_server release_daikoku ;; - manual) + build) clean + build_ui + build_daikoku + ;; + test) + test_servers + ;; + manual) build_manual ;; fmt)