Skip to content

Commit 9801fb4

Browse files
committed
🎉 Initial commit
Signed-off-by: mathieu.brunot <[email protected]>
0 parents  commit 9801fb4

11 files changed

+1069
-0
lines changed

.gitattributes

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Autodetect text files
2+
* text=auto
3+
4+
# ...Unless the name matches the following
5+
# overriding patterns
6+
7+
# Definitively text files
8+
*.txt text
9+
*.svg text
10+
*.md text
11+
*.sh text eol=lf
12+
*.yml text eol=lf
13+
Dockerfile text eol=lf
14+
15+
# Ensure those won't be messed up with
16+
*.jpg binary
17+
*.jpeg binary
18+
*.png binary
19+
*.data binary

.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees:
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees:
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Pull Request
3+
about: Create a Pull Request to help us improve
4+
title: ':gitmoji: Subject'
5+
labels:
6+
assignees:
7+
8+
---
9+
10+
<!--
11+
12+
Some key notes before you open a PR:
13+
14+
1. Select which branch should this PR be merged in? By default, you should always merge to the develop branch.
15+
2. PR name follows [convention](http://karma-runner.github.io/4.0/dev/git-commit-msg.html)
16+
3. All tests pass locally, UI and Unit tests
17+
4. All business logic and validations must be on the server-side
18+
5. Update necessary Documentation
19+
6. Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes
20+
21+
22+
Also, if you're new here
23+
24+
- Contribution Guide => https://github.com/Monogramm/__app_slug__/blob/master/CONTRIBUTING.md
25+
26+
-->
27+
28+
> Please provide enough information so that others can review your pull request:
29+
30+
<!-- You can skip this if you're fixing a typo or updating existing documentation -->
31+
32+
> Explain the **details** for making this change. What existing problem does the pull request solve?
33+
34+
<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
35+
36+
> Screenshots/GIFs
37+
38+
<!-- Add images/recordings to better visualize the change: expected/current behviour -->

.github/config.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
2+
3+
# Comment to be posted to on first time issues
4+
newIssueWelcomeComment: >
5+
Thanks for opening your first issue here! Be sure to follow the issue template!
6+
7+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
8+
9+
# Comment to be posted to on PRs from first time contributors in your repository
10+
newPRWelcomeComment: >
11+
Thanks for opening this pull request! Please check out our contributing guidelines.
12+
13+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
14+
15+
# Comment to be posted to on pull requests merged by a first time user
16+
firstPRMergeComment: >
17+
:tada: Congrats on merging your first pull request! We here at behaviorbot are proud of you!
18+
19+
# It is recommend to include as many gifs and emojis as possible
20+
21+
# Configuration for request-info - https://github.com/behaviorbot/request-info
22+
23+
# *Required* Comment to reply with
24+
requestInfoReplyComment: >
25+
We would appreciate it if you could provide us with more info about this issue/pr!
26+
27+
# *OPTIONAL* default titles to check against for lack of descriptiveness
28+
# MUST BE ALL LOWERCASE
29+
requestInfoDefaultTitles:
30+
- update readme.md
31+
- updates
32+
33+
34+
# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given
35+
requestInfoLabelToAdd: needs-more-info

.github/stale.yml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
# Number of days of inactivity before an issue becomes stale
4+
daysUntilStale: 60
5+
# Number of days of inactivity before a stale issue is closed
6+
daysUntilClose: 30
7+
8+
# Issues with these labels will never be considered stale
9+
exemptLabels:
10+
- pinned
11+
- security
12+
13+
# Label to use when marking an issue as stale
14+
staleLabel: wontfix
15+
16+
# Comment to post when marking an issue as stale. Set to `false` to disable
17+
markComment: >
18+
This issue has been automatically marked as stale because it has not had
19+
recent activity. It will be closed if no further activity occurs. Thank you
20+
for your contributions.
21+
22+
# Comment to post when closing a stale issue. Set to `false` to disable
23+
closeComment: false

.travis.yml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
os: linux
2+
dist: trusty
3+
4+
language: shell
5+
6+
branches:
7+
only:
8+
- master
9+
- develop
10+
11+
before_script:
12+
- env | sort
13+
- export TAG=travis
14+
- export VCS_REF=`git rev-parse --short HEAD`
15+
- export BUILD_DATE=`date -u +"%Y-%m-%dT%H:%M:%SZ"`
16+
- export IMAGE_NAME=__app_slug__
17+
18+
script:
19+
# Build project
20+
- echo "[TODO] Test that your project builds properly"
21+
# Execute project Unit Tests
22+
- echo "[TODO] Test that your project Unit Tests execute properly"
23+
# Run project
24+
- echo "[TODO] Test that your project runs properly"
25+
26+
notifications:
27+
email: false
28+
29+
matrix:
30+
allow_failures:
31+
- env: VERSION=0.1
32+
33+
env: # Environments
34+
- VERSION=1.0

CODE_OF_CONDUCT.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at opensource at monogramm dot io. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Contributing
2+
============
3+
4+
First of all, **thank you** for contributing, **you are awesome**!
5+
6+
You can report bugs or request new features by creating an [issue](https://github.com/Monogramm/__app_slug__/issues), or submit a [pull request](https://github.com/Monogramm/__app_slug__/pulls) with your contribution.
7+
8+
Here are a few rules to follow in order to ease code reviews and discussions before maintainers accept and merge your work.
9+
10+
<!--
11+
[TODO] Replace the best practices depending on the project's language and framework.
12+
-->
13+
You MUST follow the [Best practices for this project language and framework](https://en.wikipedia.org/wiki/Best_coding_practices). If you don't know about any of them, you should really read the recommendations.
14+
15+
You MUST run the CI test suite and ensure it is successful. If you haven't enabled it on your fork, it will be automatically triggered when opening/pushing a Pull Request (PR).
16+
17+
You SHOULD write documentation.
18+
19+
Please, write [commit messages that make sense](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), and [rebase your branch](http://git-scm.com/book/en/Git-Branching-Rebasing) before submitting your Pull Request.
20+
21+
You MUST use the `develop` branch as the base of your Pull Request.
22+
23+
If possible, use [gitmoji](https://gitmoji.carloscuesta.me/) in your commit message to ease code reviews.
24+
25+
One may ask you to [squash your commits](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) too. This is used to "clean" your Pull Request before merging it (we don't want commits such as `fix tests`, `fix 2`, `fix 3`, etc.).
26+
27+
Also, while creating your Pull Request on GitHub, you MUST write a description which gives the context and/or explains why you are creating it. If your Pull Request is related to one or several issues, you SHOULD reference them in your PR description. See GitHub documentation on [how to close issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords).
28+
29+
Thank you!

0 commit comments

Comments
 (0)