From 7546743750661a435348b17bc7773db25b62b8c2 Mon Sep 17 00:00:00 2001 From: Ankur Singh Date: Wed, 27 Dec 2023 11:22:59 +0530 Subject: [PATCH 1/3] docs: improves the contributing docs (#1698) --- docs/contributing.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 9834925908..88ae1ade3f 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -35,7 +35,7 @@ Adding examples is quite straight forward, so don't feel shy! Here's how to do i 1. Adapt [this testing file](https://github.com/asyncapi/modelina/blob/1e71b3b2cab6bc2c277001fcafe7e1b8ed175ce9/examples/TEMPLATE/index.spec.ts#L4) for your use case. In most cases, it could be as simple as changing the title of the test! 1. Add your example to our overall list of [examples](https://github.com/asyncapi/modelina/blob/master/examples/README.md). -Aaaand you are done! :tada: +Aaaand you are done! 🎉 ### Adding a new preset Presets are for when you want to customize the generated output, they work like middleware that layers on top of each other, you can read more [about presets here](./presets.md). @@ -83,7 +83,7 @@ describe('LANGUAGE_MY_PRESET', () => { ``` Remember to replace `LANGUAGE` and `Language` with the appropriate values. -Aaaand you are done! :tada: +Aaaand you are done! 🎉 ### Adding a new input processor Input processors are the translators from inputs to MetaModel (read more about [the input processing here](./input-processing.md)). @@ -103,7 +103,7 @@ Thats it for the code and tests, now all that remains is docs and examples! :fir 2. Add the [usage example to the usage document](./usage.md). 3. Add the new supported input to the [main readme file](../README.md#features). -Aaaand you are done! :tada: +Aaaand you are done! 🎉 ### Adding a new generator Generators sits as the core of Modelina, which frames the core concepts of what you can generate. Therefore it's also no small task to create a new one, so dont get discourage, we are here to help you! @@ -167,4 +167,4 @@ That said, here is a general rundown on what's triggered by each PR: - [Coverall](https://github.com/asyncapi/modelina/blob/master/.github/workflows/coverall.yml) ensures we get test coverage statistics in each PR, thus ensuring we see how it affects overall test coverage. It creates a comment on the PR with the coverage status. - [SonarCloud](https://sonarcloud.io/dashboard?id=asyncapi_generator-model-sdk) runs a code analysis to ensure no bugs, security concerns, code smells, or duplicated code blocks. Make sure you address any concerns found by this bot, because it generates a comment to the PR if it finds any issue. -At the end of the day, sometimes checks just fail, based on weird dependency problems. If any test failures occur that don't look like a problem you can fix, simply tag one of the maintainers. We're there to help! :smile: +At the end of the day, sometimes checks just fail, based on weird dependency problems. If any test failures occur that don't look like a problem you can fix, simply tag one of the maintainers. We're there to help! 😀 From d974d2e93d02e0ddb064ed72b6a1db2a1f78ab12 Mon Sep 17 00:00:00 2001 From: Devansh Mahant <86195162+devansh-m12@users.noreply.github.com> Date: Wed, 27 Dec 2023 11:24:03 +0530 Subject: [PATCH 2/3] docs: update Emojis Not Rendering Properly in docs (#1699) --- docs/contributing.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 88ae1ade3f..5e944abc7c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -83,7 +83,7 @@ describe('LANGUAGE_MY_PRESET', () => { ``` Remember to replace `LANGUAGE` and `Language` with the appropriate values. -Aaaand you are done! 🎉 +Aaaand you are done! 🎉 ### Adding a new input processor Input processors are the translators from inputs to MetaModel (read more about [the input processing here](./input-processing.md)). @@ -98,12 +98,12 @@ Here is how you can add a new input processor: 7. Add your input processor as part of the [main input processor](../src/processors/InputProcessor.ts) 8. Add a [test for the main input processor](../test/processors/InputProcessor.spec.ts) to ensure that your input processor are accessed accordingly. -Thats it for the code and tests, now all that remains is docs and examples! :fire: +Thats it for the code and tests, now all that remains is docs and examples! 🔥 1. [Add a new example](#adding-examples) showcasing the new supported input. 2. Add the [usage example to the usage document](./usage.md). 3. Add the new supported input to the [main readme file](../README.md#features). -Aaaand you are done! 🎉 +Aaaand you are done! 🎉 ### Adding a new generator Generators sits as the core of Modelina, which frames the core concepts of what you can generate. Therefore it's also no small task to create a new one, so dont get discourage, we are here to help you! @@ -167,4 +167,4 @@ That said, here is a general rundown on what's triggered by each PR: - [Coverall](https://github.com/asyncapi/modelina/blob/master/.github/workflows/coverall.yml) ensures we get test coverage statistics in each PR, thus ensuring we see how it affects overall test coverage. It creates a comment on the PR with the coverage status. - [SonarCloud](https://sonarcloud.io/dashboard?id=asyncapi_generator-model-sdk) runs a code analysis to ensure no bugs, security concerns, code smells, or duplicated code blocks. Make sure you address any concerns found by this bot, because it generates a comment to the PR if it finds any issue. -At the end of the day, sometimes checks just fail, based on weird dependency problems. If any test failures occur that don't look like a problem you can fix, simply tag one of the maintainers. We're there to help! 😀 +At the end of the day, sometimes checks just fail, based on weird dependency problems. If any test failures occur that don't look like a problem you can fix, simply tag one of the maintainers. We're there to help! 😄 From 0652c6999cc482beb5da37f20ed8d2e7287e1196 Mon Sep 17 00:00:00 2001 From: "allcontributors[bot]" <46447321+allcontributors[bot]@users.noreply.github.com> Date: Tue, 26 Dec 2023 19:55:42 -1000 Subject: [PATCH 3/3] docs: add devansh-m12 as a contributor for doc (#1704) * update README.md * update .all-contributorsrc --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> --- .all-contributorsrc | 9 +++++++++ README.md | 3 ++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/.all-contributorsrc b/.all-contributorsrc index 335805d7e2..ef18e312b9 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -808,6 +808,15 @@ "contributions": [ "test" ] + }, + { + "login": "devansh-m12", + "name": "Devansh Mahant", + "avatar_url": "https://avatars.githubusercontent.com/u/86195162?v=4", + "profile": "https://github.com/devansh-m12", + "contributions": [ + "doc" + ] } ], "contributorsPerLine": 7, diff --git a/README.md b/README.md index 77656f660f..efecff2e2d 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ [![Discussions](https://img.shields.io/github/discussions/asyncapi/modelina)](https://github.com/asyncapi/modelina/discussions) [![Website](https://img.shields.io/website?label=website&url=https%3A%2F%2Fwww.modelina.org)](https://www.modelina.org) [![Playground](https://img.shields.io/website?label=playground&url=https%3A%2F%2Fwww.modelina.org%2Fplayground)](https://www.modelina.org/playground) -[![All Contributors](https://img.shields.io/badge/all_contributors-74-orange.svg?style=flat-square)](#contributors-) +[![All Contributors](https://img.shields.io/badge/all_contributors-75-orange.svg?style=flat-square)](#contributors-) Your one-stop tool for generating accurate and well-tested models for representing the message payloads. Use it as a tool in your development workflow, or a library in a larger integrations, entirely in your control. @@ -420,6 +420,7 @@ Thanks go out to these wonderful people ([emoji key](https://allcontributors.org Ashmit JaiSarita Gupta
Ashmit JaiSarita Gupta
💻 🎨 📖 🚧 Harshil Jani
Harshil Jani
💻 ⚠️ Mintu Gogoi
Mintu Gogoi
⚠️ + Devansh Mahant
Devansh Mahant
📖