Skip to content

Commit

Permalink
Merge branch 'release/1.2.1'
Browse files Browse the repository at this point in the history
  • Loading branch information
hauke96 committed Dec 8, 2020
2 parents 2d4907f + 882a136 commit 8c0513e
Show file tree
Hide file tree
Showing 16 changed files with 1,166 additions and 33 deletions.
98 changes: 98 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
This file contains some information on how to contribute to this project.

# How can I contribute?

There are several ways you can contribute:

* Report a bug or problem
* Add feature requests or take part in a feature discussion
* Add/extend/fix/modify translation files
* Add/extend/fix/modify documentation
* Fix a bug
* Implement a feature
* ...

## Contribute non-code stuff

**Note:** Everything regarding translation and documentation is considered "code" because you have to create git commits and a pull request.

### Report a bug

Feel free to [create an issue](https://github.com/hauke96/simple-task-manager/issues/new) and put the following things into the issue description:

* Version of STM (visible on the bottom of the page)
* The chronology of the situation:
* What you have done *before* the bug occurred?
* What was the desired behavior/result?
* What was the actual behavior/result (aka the bug)?
* Describe as detailed as possible what went wrong. Just saying "Project creation not working" isn't that helpful but "When clicking 'create project' the error message '.......' appears" is more helpful.
* Have you tried anything to alanyze/remove/get around the bug? If yes, what have you tried? E.g. trying a different browser, etc.

Any further information may help to determine the bug: Screenshots, browser console output, strange network behavior or anything else you noticed.

### Add feature request

Feel free to [create an issue](https://github.com/hauke96/simple-task-manager/issues/new) and put the following things into the issue description:

* In a few sentences: What is this feature about?
* Example: "I want to subdivide tasks during the project creation."
* To help others understand you wish, add some context. Why do you want this feature? What makes it useful for the STM?
* Example: "This enabled me to easily create several uniformly sized tasks for a specific region and therefore saves a lot of time."
* Also adding more content, mockups, drawings, examples, etc. may help.
* Example: "I want to choose between multiple possible shapes like in the app XYZ: https://..."
* If you are a programmer and have ideas regarding the implementation, feel free to add them.

## Contribute code

Before you start implementing a larger feature: Start an issue and be open for a discussion.

### Getting started

Read the [doc/development README](./doc/development/README.md) which shows you how to setup the project and gives you an idea about a possible workflow.
It also links further down to client and server documentation files.

### Branching

Some words on the branches:

* `master`: Contains the last deployed code (probably not up to date).
* `dev`: Contains the latest code. However, some larger feature may still be on separate feature-branches.
* `release/...`: Contains preparations for a release. Will soon be merged into `master` and `dev`.
* `feature/...`: Contains unfinished code for a specific feature.

**Never** use the `master` branch because it doesn't contain the latest changes.
Usually you should use the `dev` branch.

### Fix a bug

1. For the repo
2. Check if the bug has already been fixed:
1. Go onto the `dev` branch
2. Start everything locally
3. Try to reproduce the bug
4. If bug hasn't been fixed on the `dev` branch: Keep on reading. If bug is fixed: Stop reading, nothing to do.
3. Go to the github issue or create a new one and assign yourself to to issue
4. Go back to your code and write a test which detects the bug
4. Fix the bug (nothing easier than that :P )
5. Make sure no tests are failing and the code format is fine
6. Update your branch by pulling the latest changes from the main STM repo
7. Create a pull request

### Add a feature

After checking the issue page, finishing discussions or asking questions, you are ready to start a new feature.

1. For the repo
2. Go to the `dev` branch
3. Create a new `feature/my-super-duper-feature` branch (as described in the [development README](./doc/development/README.md))
4. Start implementing your feature
1. Also add tests
2. Maybe adjust the documentation if e.g. a new API endpoint needs to be created
3. Maybe update and adjust the clients translation files
5. Make sure no tests are failing and the code format is fine
6. Update your branch by pulling the latest changes from the main STM repo
7. Create a pull request

## Code conventions

See the [development README](./doc/development/README.md) for details.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ Currently there's no end user manual, tutorial or something similar.

# Contribute

Currently there are no real guidelines. Feel free to create an **issue** or **pull request**.
Feel free to create an **issue** or **pull request**.

**Wanna start coding?** Take a look at [doc/development/README.md](doc/development/README.md) on how to get started.
For further information, take a look at the [CONTRIBUTING.md](./CONTRIBUTING.md).

**Wanna start coding?** Read the [doc/development/README.md](doc/development/README.md) to learn how to get started.
2 changes: 1 addition & 1 deletion client/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## STAGE 1 : Build the client
FROM simpletaskmanager/stm-client-base:1.2.0 as builder
FROM simpletaskmanager/stm-client-base:1.2.1 as builder

COPY ./ /stm-client/
WORKDIR /stm-client/
Expand Down
2 changes: 1 addition & 1 deletion client/Dockerfile-test
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## STAGE 1 : Build the client
FROM simpletaskmanager/stm-client-base:1.2.0 as builder
FROM simpletaskmanager/stm-client-base:1.2.1 as builder

COPY ./ /stm-client/
WORKDIR /stm-client/
Expand Down
4 changes: 4 additions & 0 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ The output will be in `client/dist/simple-taskmanager/<lang>`, where `en-US` for
**Beware:** This may take some time (up to several minutes), depending on your machine.
# Code conventions
See the [development README](../doc/development/README.md) for details.
# Configuration
Currently the client has a very simple dev- and prod-configuration in `client/src/environments`.
Expand Down
11 changes: 10 additions & 1 deletion client/angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"locales": {
"ja": "src/locale/messages.ja.xlf",
"de": "src/locale/messages.de.xlf",
"zh-CN": "src/locale/messages.zh-CN.xlf"
"zh-CN": "src/locale/messages.zh-CN.xlf",
"fr": "src/locale/messages.fr.xlf"
}
},
"architect": {
Expand Down Expand Up @@ -74,6 +75,11 @@
"zh-CN"
]
},
"fr": {
"localize": [
"fr"
]
},
"production": {
"fileReplacements": [
{
Expand Down Expand Up @@ -155,6 +161,9 @@
},
"zh-CN": {
"browserTarget": "simple-task-manager:build:zh-CN"
},
"fr-FR": {
"browserTarget": "simple-task-manager:build:fr-FR"
}
}
},
Expand Down
2 changes: 1 addition & 1 deletion client/nginx-test.conf
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ server {
ssl_certificate /etc/letsencrypt/live/stm-test.hauke-stieler.de/cert.pem;
ssl_certificate_key /etc/letsencrypt/live/stm-test.hauke-stieler.de/privkey.pem;

location ~ ^/(en-US|ja|de|zh-CN)/ {
location ~ ^/(en-US|ja|de|zh-CN|fr)/ {
root /usr/share/nginx/html;
index index.html;
try_files $uri$args $uri$args/ /$1/index.html;
Expand Down
2 changes: 1 addition & 1 deletion client/nginx.conf
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ server {
ssl_certificate /etc/letsencrypt/live/stm.hauke-stieler.de/cert.pem;
ssl_certificate_key /etc/letsencrypt/live/stm.hauke-stieler.de/privkey.pem;

location ~ ^/(en-US|ja|de|zh-CN)/ {
location ~ ^/(en-US|ja|de|zh-CN|fr)/ {
root /usr/share/nginx/html;
index index.html;
try_files $uri$args $uri$args/ /$1/index.html;
Expand Down
2 changes: 1 addition & 1 deletion client/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion client/package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
{
"name": "simple-task-manager",
"version": "1.2.0",
"version": "1.2.1",
"scripts": {
"ng": "ng",
"dev": "ng serve --watch",
"dev-ja": "ng serve --watch --configuration=ja",
"dev-de": "ng serve --watch --configuration=de",
"dev-zh": "ng serve --watch --configuration=zh-CN",
"dev-fr": "ng serve --watch --configuration=fr",
"dev-local": "ng serve --watch -c local",
"build": "ng build --localize",
"build-prod": "ng build --prod --localize",
Expand Down
1 change: 1 addition & 0 deletions client/src/app/common/selected-language.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export class SelectedLanguageService {
new Language('de', 'Deutsch'),
new Language('ja', '日本語'),
new Language('zh-CN', '中文'),
new Language('fr', 'Français'),
];
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ export class ProjectCreationComponent implements OnInit, AfterViewInit {
this.removeInteraction = new Select();
this.removeInteraction.on('select', (e: SelectEvent) => {
if (!!e.selected[0]) {
let id = e.selected[0].get('id');
const id = e.selected[0].get('id');
this.taskDraftService.removeTask(id);
}
});
Expand Down
Loading

0 comments on commit 8c0513e

Please sign in to comment.