Skip to content

Commit b3312e4

Browse files
lbroudouxlbroudoux
committed
Putting community health files
Signed-off-by: Laurent Broudoux <[email protected]>
1 parent 684ccf6 commit b3312e4

File tree

8 files changed

+186
-0
lines changed

8 files changed

+186
-0
lines changed

‎CODEOWNERS

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# This file provides an overview of code owners in this repository.
2+
3+
# Each line is a file pattern followed by one or more owners.
4+
# The last matching pattern has the most precedence.
5+
# For more details, read the following article on GitHub: https://help.github.com/articles/about-codeowners/.
6+
7+
# The default owners are automatically added as reviewers when you open a pull request unless different owners are specified in the file.
8+
9+
* @lbroudoux

‎CODE_OF_CONDUCT.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Microcks Community Code of Conduct
2+
3+
Microcks project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
4+
5+
## Our Pledge
6+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
7+
8+
## Enforcement
9+
10+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team via [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

‎CONTRIBUTING.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Contributing to Microcks
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible.
4+
5+
## Contribution recogniton
6+
7+
We plan to use [All Contributors](https://allcontributors.org/docs/en/specification) specification to handle recognitions.
8+
9+
## Summary of the contribution flow
10+
11+
The following is a summary of the ideal contribution flow. Please, note that Pull Requests can also be rejected by the maintainers when appropriate.
12+
13+
```
14+
┌───────────────────────┐
15+
│ │
16+
│ Open an issue │
17+
│ (a bug report or a │
18+
│ feature request) │
19+
│ │
20+
└───────────────────────┘
21+
⇩
22+
┌───────────────────────┐
23+
│ │
24+
│ Open a Pull Request │
25+
│ (only after issue │
26+
│ is approved) │
27+
│ │
28+
└───────────────────────┘
29+
⇩
30+
┌───────────────────────┐
31+
│ │
32+
│ Your changes will │
33+
│ be merged and │
34+
│ published on the next │
35+
│ release │
36+
│ │
37+
└───────────────────────┘
38+
```
39+
40+
## Code of Conduct
41+
42+
Microcks has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](CODE_OF_CONDUCT.md) so that you can understand what sort of behaviour is expected.
43+
44+
## Our Development Process
45+
46+
We use Github to host code, to track issues and feature requests, as well as accept pull requests.
47+
48+
## Issues
49+
50+
[Open an issue](https://github.com/microcks/microcks/issues/new) **only** if you want to report a bug or a feature. Don't open issues for questions or support, instead join our [Zulip #user channel](https://microcksio.zulipchat.com/) or our [GitHub discussions](https://github.com/orgs/microcks/discussions) and ask there.
51+
52+
## Bug Reports and Feature Requests
53+
54+
Please use our issues templates that provide you with hints on what information we need from you to help you out.
55+
56+
## Pull Requests
57+
58+
**Please, make sure you open an issue before starting with a Pull Request, unless it's a typo or a really obvious error.** Pull requests are the best way to propose changes to the specification. Take time to check the current working branch for the repository you want to contribute on before working :wink:
59+
60+
## Conventional commits
61+
62+
Our repositories follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) specification. Releasing to GitHub and NPM is done with the support of [semantic-release](https://semantic-release.gitbook.io/semantic-release/).
63+
64+
Pull requests should have a title that follows the specification, otherwise, merging is blocked. If you are not familiar with the specification simply ask maintainers to modify. You can also use this cheatsheet if you want:
65+
66+
- `fix: ` prefix in the title indicates that PR is a bug fix and PATCH release must be triggered.
67+
- `feat: ` prefix in the title indicates that PR is a feature and MINOR release must be triggered.
68+
- `docs: ` prefix in the title indicates that PR is only related to the documentation and there is no need to trigger release.
69+
- `chore: ` prefix in the title indicates that PR is only related to cleanup in the project and there is no need to trigger release.
70+
- `test: ` prefix in the title indicates that PR is only related to tests and there is no need to trigger release.
71+
- `refactor: ` prefix in the title indicates that PR is only related to refactoring and there is no need to trigger release.
72+
73+
What about MAJOR release? just add `!` to the prefix, like `fix!: ` or `refactor!: `
74+
75+
Prefix that follows specification is not enough though. Remember that the title must be clear and descriptive with usage of [imperative mood](https://chris.beams.io/posts/git-commit/#imperative).
76+
77+
Happy contributing :heart:
78+
79+
## License
80+
81+
When you submit changes, your submissions are understood to be under the same [Apache 2.0 License](https://github.com/microcks/microcks/blob/master/LICENSE) that covers the project. Feel free to [contact the maintainers](https://microcksio.zulipchat.com/) if that's a concern.
82+
83+
## References
84+
85+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md).

‎MAINTAINERS.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Overview
2+
3+
This document contains a list of maintainers in this repo.
4+
If you're interested in contributing, and becoming a maintainer, see [CONTRIBUTING](CONTRIBUTING.md).
5+
6+
## Current Maintainers
7+
8+
| Maintainer | GitHub ID | Email |
9+
| ------------------ | --------------------------------------------------------- | ----------------------- |
10+
| Laurent Broudoux | [lbroudoux](https://github.com/lbroudoux) | [email protected] |
11+
| Yacine Kheddache | [yada](https://github.com/yada) | [email protected] |
12+
13+
## Emeritus
14+
15+
| Maintainer | GitHub ID | Email |
16+
| ------------------ | --------------------------------------------------------- | ----------------------- |

‎SECURITY.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
If you've found a vulnerability in our components or website, or want additional information regarding how we manage security, please report it via a [GitHub discussion](https://github.com/microcks/microcks/discussions).
6+
7+
In case you do not want to publicly report a security issue for one of the libraries owned by the Microcks community, write an email with a detailed description of the issue to [email protected].

‎microcks-docker-compose.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
services:
2+
importer:
3+
depends_on:
4+
- microcks
5+
restart: on-failure
6+
image: quay.io/microcks/microcks-cli:latest
7+
volumes:
8+
- "./test/resources:/resources"
9+
entrypoint:
10+
- microcks-cli
11+
- import
12+
- '/resources/order-service-openapi.yml:true,/resources/order-events-asyncapi.yml:true,/resources/apipastries-openapi.yml:true,/resources/apipastries-postman-collection.json:false'
13+
- --microcksURL=http://microcks:8080/api
14+
- --insecure
15+
- --keycloakClientId=foo
16+
- --keycloakClientSecret=bar
17+
18+
microcks:
19+
image: quay.io/microcks/microcks-uber:1.9.0-native
20+
ports:
21+
- "9090:8080"
22+
environment:
23+
- TEST_CALLBACK_URL=http://microcks:8080
24+
- ASYNC_MINION_URL=http://microcks-async-minion:8081
25+
26+
async-minion:
27+
depends_on:
28+
- microcks
29+
ports:
30+
- "9091:8081"
31+
image: quay.io/microcks/microcks-uber-async-minion:1.9.0
32+
container_name: microcks-async-minion
33+
restart: on-failure
34+
environment:
35+
- MICROCKS_HOST_PORT=microcks:8080
36+
- ASYNC_PROTOCOLS=WS,KAFKA
37+
- KAFKA_BOOTSTRAP_SERVER=kafka:19092
38+
39+
kafka:
40+
image: vectorized/redpanda:v22.2.2
41+
container_name: microcks-kafka
42+
command: [
43+
"redpanda", "start",
44+
"--overprovisioned --smp 1 --memory 1G --reserve-memory 0M --node-id 0 --check=false",
45+
"--kafka-addr PLAINTEXT://0.0.0.0:19092,EXTERNAL://0.0.0.0:9092",
46+
"--advertise-kafka-addr PLAINTEXT://kafka:19092,EXTERNAL://localhost:9092"
47+
]
48+
ports:
49+
- "9092:9092"
50+
- "19092:19092"

‎microcks.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docker compose -f microcks-docker-compose.yml up

‎nest-cli.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"$schema": "https://json.schemastore.org/nest-cli",
3+
"collection": "@nestjs/schematics",
4+
"sourceRoot": "src",
5+
"compilerOptions": {
6+
"deleteOutDir": true
7+
}
8+
}

0 commit comments

Comments
 (0)