Skip to content

Commit

Permalink
Update contributin
Browse files Browse the repository at this point in the history
  • Loading branch information
mathieuancelin committed Dec 2, 2019
1 parent 95e9be4 commit e3f15be
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 96 deletions.
18 changes: 13 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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.
51 changes: 0 additions & 51 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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 <feature_branch>
bundle; script/server
```

1.

## Impacted Areas in Application
List general components of the application that this PR will affect:

*
11 changes: 9 additions & 2 deletions scripts/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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)
Expand Down

0 comments on commit e3f15be

Please sign in to comment.