Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: release of long living release candidate #764

Merged
merged 146 commits into from
Sep 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
146 commits
Select commit Hold shift + click to select a range
afa84a8
refactor: switch to parser-js in most places (#264)
magicmatatjahu Mar 18, 2021
a3d9ebf
refactor: rewrite Schema component (#269)
magicmatatjahu Mar 23, 2021
3d7c733
refactor: rewritten Info component (#277)
aeworxet Mar 25, 2021
883916f
refactor: unify Messages and Operations components (#276)
magicmatatjahu Mar 25, 2021
6b2807c
refactor: unify bindings and extensions (#280)
magicmatatjahu Mar 29, 2021
ed84be2
refactor: remove leftover code (#285)
magicmatatjahu Mar 31, 2021
8b0288c
refactor: unify Servers (#288)
magicmatatjahu Apr 1, 2021
ba91b1e
refactor: add sidebar and render examples (#291)
magicmatatjahu Apr 7, 2021
477f015
refactor: unify styling (#296)
magicmatatjahu Apr 15, 2021
320c389
chore: add esm, cjs and umd bundles (#297)
magicmatatjahu Apr 16, 2021
99969ac
docs: unify documentation (#302)
magicmatatjahu Apr 20, 2021
2ed20c1
ci: add bump workflow (#307)
magicmatatjahu Apr 20, 2021
2dcc730
refactor: remove unnecessary code (#309)
magicmatatjahu Apr 21, 2021
2bc32e8
refactor: unify styling vol.2 (#310)
magicmatatjahu Apr 26, 2021
3f0c181
ci: update workflows for next (#322)
magicmatatjahu Apr 29, 2021
8144017
feat: next release. BREAKING CHANGE: unify html-template with react-c…
magicmatatjahu May 4, 2021
da4fa1a
ci: fix checkout to next branch (#325)
magicmatatjahu May 4, 2021
6b64a64
feat!: unify react-component with html-template (#327)
magicmatatjahu May 4, 2021
85ac790
chore(release): v1.0.0-next.1 (#328)
asyncapi-bot May 4, 2021
aa03538
fix: strictly check if a given part of spec exists and render single …
magicmatatjahu May 7, 2021
2a5b42d
chore(release): v1.0.0-next.2 (#340)
asyncapi-bot May 7, 2021
3517888
refactor: infer types in proper way and add tests (#332)
magicmatatjahu May 17, 2021
704dd47
chore: render schema dependencies (#334)
magicmatatjahu May 17, 2021
0371914
feat: render missed parts of spec (#345)
magicmatatjahu May 19, 2021
164f289
chore(release): v1.0.0-next.3 (#347)
asyncapi-bot May 19, 2021
6f3a6ac
ci: update semantic-release packages and related workflows (#349)
magicmatatjahu May 20, 2021
02c40d8
feat: update openapi-sampler package to 1.0.0 (#355)
magicmatatjahu May 26, 2021
f1652df
chore(release): v1.0.0-next.4 (#359)
asyncapi-bot May 26, 2021
ed998f9
ci: publish playground from next branch (#352)
magicmatatjahu May 26, 2021
3ddad45
fix: rendering the circular items (#356)
magicmatatjahu May 26, 2021
d121cb8
chore(release): v1.0.0-next.5 (#360)
asyncapi-bot May 26, 2021
0f7e977
feat: add standalone bundle (#333)
magicmatatjahu Jun 4, 2021
75bcc36
chore(release): v1.0.0-next.6 (#365)
asyncapi-bot Jun 4, 2021
67b4386
feat: highlight code blocks in markdown (#361)
magicmatatjahu Jun 11, 2021
67722f8
chore(release): v1.0.0-next.7 (#366)
asyncapi-bot Jun 11, 2021
8a569e5
fix: decrease the marked.js version to 2.0.7 (#371)
magicmatatjahu Jun 16, 2021
636f24e
chore(release): v1.0.0-next.8 (#372)
asyncapi-bot Jun 16, 2021
98c158b
fix: support true/false JSON schemas (#367)
magicmatatjahu Jun 22, 2021
bfc35e1
chore(release): v1.0.0-next.9 (#379)
asyncapi-bot Jun 22, 2021
0a20c45
feat: support for 2.1.0 version of spec (#362)
magicmatatjahu Jun 29, 2021
3f75231
chore(release): v1.0.0-next.10 (#385)
asyncapi-bot Jun 29, 2021
55cd198
fix: update openapi-sampler to 1.1.0 (#387)
magicmatatjahu Jul 5, 2021
f17312b
chore(release): v1.0.0-next.11 (#388)
asyncapi-bot Jul 5, 2021
51a62a9
feat: enable rendering of extensions on channel level (#389)
derberg Jul 9, 2021
c418164
chore(release): v1.0.0-next.12 (#390)
asyncapi-bot Jul 9, 2021
1669d71
docs: add doc for Standalone Bundle (#395)
magicmatatjahu Jul 19, 2021
31c4c57
feat: render schemas as standalone components and add ids (#397)
magicmatatjahu Jul 20, 2021
39c8da1
chore(release): v1.0.0-next.13 (#398)
asyncapi-bot Jul 20, 2021
1f89fe3
fix: show only schemas and messages from components (#399)
magicmatatjahu Jul 21, 2021
fc859ae
chore(release): v1.0.0-next.14 (#400)
asyncapi-bot Jul 21, 2021
e4e0f7c
fix: point to appropriate message in sidebar (#401)
magicmatatjahu Jul 27, 2021
d161227
chore(release): v1.0.0-next.15 (#402)
asyncapi-bot Jul 27, 2021
19f8558
fix: add styles to sideEffects (#408)
andreafalzetti Aug 16, 2021
f68e284
chore(release): v1.0.0-next.16 (#412)
asyncapi-bot Aug 16, 2021
0f9f81c
fix: bump avro parser to 0.3.0 to support examples (#411)
derberg Aug 16, 2021
31d78e0
chore(release): v1.0.0-next.17 (#413)
asyncapi-bot Aug 16, 2021
e238fc5
feat: render binding in capsule instead of drop down (#416)
magicmatatjahu Aug 24, 2021
8654d32
chore(release): v1.0.0-next.18 (#417)
asyncapi-bot Aug 24, 2021
49b460a
feat: support 2.2.0 AsyncAPI (#438)
magicmatatjahu Sep 28, 2021
9b2d66d
chore(release): v1.0.0-next.19 (#444)
asyncapi-bot Sep 28, 2021
a86059e
fix: make fallback for 2.2.0 channel.servers field (#445)
magicmatatjahu Sep 29, 2021
aa4bfa9
chore(release): v1.0.0-next.20 (#446)
asyncapi-bot Sep 29, 2021
072659e
feat: add essential Kafka client security config (#447)
dalelane Oct 11, 2021
d1cb17f
chore(release): v1.0.0-next.21 (#453)
asyncapi-bot Oct 11, 2021
e1c3399
feat: handle circular refs (#465)
magicmatatjahu Nov 23, 2021
385b586
chore(release): v1.0.0-next.22 (#482)
asyncapi-bot Nov 23, 2021
5487d3b
fix: bump parser-js dep to 1.12.0 (#485)
magicmatatjahu Nov 23, 2021
457e522
chore(release): v1.0.0-next.23 (#486)
asyncapi-bot Nov 23, 2021
94e94a5
feat: support stringified AsyncAPI documents (#487)
magicmatatjahu Dec 1, 2021
2ee7ee3
chore(release): v1.0.0-next.24 (#492)
asyncapi-bot Dec 1, 2021
49438cf
feat: introduce scoped css for default styles (#493)
kaiszybiak Dec 6, 2021
5ecf53c
chore(release): v1.0.0-next.25 (#494)
asyncapi-bot Dec 6, 2021
609aa12
fix: improve performance of resizeObserver (#499)
magicmatatjahu Dec 21, 2021
c416113
chore(release): v1.0.0-next.26 (#501)
asyncapi-bot Dec 21, 2021
5412033
fix: render empty extensions and bindings (#502)
magicmatatjahu Jan 4, 2022
21758c0
chore(release): v1.0.0-next.27 (#503)
asyncapi-bot Jan 4, 2022
6e55da9
docs: added gitpod support (#507)
Samridhi-98 Jan 10, 2022
42becd8
fix: adding inline sources in source maps (#505)
magicmatatjahu Jan 11, 2022
8366221
chore(release): v1.0.0-next.28 (#508)
asyncapi-bot Jan 11, 2022
9cad238
fix: indentations in the Schema component (#509)
magicmatatjahu Jan 12, 2022
eac9962
chore(release): v1.0.0-next.29 (#510)
asyncapi-bot Jan 12, 2022
32ee614
fix: do not download schemaUrl several times in a short time in the w…
magicmatatjahu Jan 13, 2022
e7c6c1f
chore(release): v1.0.0-next.30 (#515)
asyncapi-bot Jan 13, 2022
8c7f8de
fix: update marked version (#522)
Samridhi-98 Jan 17, 2022
75abc5a
chore(release): v1.0.0-next.31 (#523)
asyncapi-bot Jan 17, 2022
29be6ff
fix: switch to any type for jsonToSchema function (#527)
dschwank Jan 19, 2022
4b4ee8f
chore(release): v1.0.0-next.32 (#528)
asyncapi-bot Jan 19, 2022
a59272a
docs: add info about custom styling & custom logo (#531)
thim81 Jan 31, 2022
9904dc5
feat: support 2.3.0 version of spec (#540)
magicmatatjahu Jan 31, 2022
3ece659
chore(release): v1.0.0-next.33 (#541)
asyncapi-bot Jan 31, 2022
d15f4a6
fix: remove lowercase css class to display pattern field as expected …
M3lkior Feb 18, 2022
6497024
chore(release): v1.0.0-next.34 (#551)
asyncapi-bot Feb 18, 2022
e0317fa
chore: replace @github-actions[bot] with @asyncapi-bot-eve (#555)
magicmatatjahu Mar 2, 2022
adf8c23
ci: update workflows (#558)
magicmatatjahu Mar 3, 2022
b02c4fd
fix: bump dependencies in package-lock files (#569)
W0nderMuffin Apr 5, 2022
bc0f158
chore(release): v1.0.0-next.35 (#570)
asyncapi-bot Apr 5, 2022
4cd24d0
fix: bump dependencies (#580)
magicmatatjahu Apr 19, 2022
b04a1a5
chore(release): v1.0.0-next.36 (#581)
asyncapi-bot Apr 19, 2022
4569406
docs: fix broken link (#583)
marceloavan Apr 27, 2022
dc484aa
feat: support AsyncAPI 2.4.0 (#584)
magicmatatjahu Apr 27, 2022
b3fcefe
chore(release): v1.0.0-next.37 (#588)
asyncapi-bot Apr 27, 2022
b268c0c
fix: add fallback for null parameter's schema (#590)
magicmatatjahu Apr 28, 2022
f08e732
chore(release): v1.0.0-next.38 (#591)
asyncapi-bot Apr 28, 2022
3660a0e
fix: define react and react-dom as peerDependencies (#614)
magicmatatjahu Jul 5, 2022
945ee73
chore(release): v1.0.0-next.39 (#623)
asyncapi-bot Jul 5, 2022
39a5fe8
feat: add deep collapse button in schema component (#620)
magicmatatjahu Jul 28, 2022
b4db0c6
chore(release): v1.0.0-next.40 (#627)
asyncapi-bot Jul 28, 2022
b507312
docs: update the command to install the component (#629)
m1ner79 Jul 29, 2022
ae3c628
feat: add config options to override pub sub label text (#632)
BTOdell Sep 8, 2022
a72bec2
chore(release): v1.0.0-next.41 (#633)
asyncapi-bot Sep 8, 2022
45e4109
fix: render default,const boolean values in Schema component (#638)
magicmatatjahu Sep 16, 2022
00f6dc8
chore(release): v1.0.0-next.42 (#639)
asyncapi-bot Sep 16, 2022
836558c
feat: support AsyncAPI 2.5.0 (#647)
magicmatatjahu Sep 29, 2022
4e5d7e8
chore(release): v1.0.0-next.43 (#650)
asyncapi-bot Sep 29, 2022
f012bca
feat: config option to expand/collapse the examples payload (#621)
AceTheCreator Nov 10, 2022
31e17f8
chore(release): v1.0.0-next.44 (#667)
asyncapi-bot Nov 10, 2022
6755f92
chore: remove react-icons dependency (#692)
shishkin Jan 23, 2023
42a349a
feat: group Servers in sidebar navigation like Operation Objects (#682)
aeworxet Jan 31, 2023
9387963
chore(release): v1.0.0-next.45 (#695)
asyncapi-bot Jan 31, 2023
fcb6d31
feat: show operation summary on sidebar (#595)
sarisia Jan 31, 2023
985a961
chore(release): v1.0.0-next.46 (#696)
asyncapi-bot Jan 31, 2023
7e42a99
feat: support AsyncAPI 2.6.0 (#699)
magicmatatjahu Feb 2, 2023
505304d
chore(release): v1.0.0-next.47 (#700)
asyncapi-bot Feb 2, 2023
1ab6b77
feat: add protobuff payload support (#719)
GreenRover Jun 12, 2023
eabba4f
feat!: update to new parser api (#746)
jonaslagoni Aug 30, 2023
cbbf569
chore(release): v1.0.0-next.49 (#747)
asyncapi-bot Aug 30, 2023
5be6cff
fix: change schema name word breaking to anywhere (#743)
Laupetin Sep 4, 2023
437c3d7
chore(release): v1.0.0-next.50 (#753)
asyncapi-bot Sep 4, 2023
3a59998
fix: broken rendering from parser upgrade (#750)
jonaslagoni Sep 4, 2023
92807d1
chore(release): v1.0.0-next.51 (#754)
asyncapi-bot Sep 4, 2023
3515f32
fix: small rendering fixes (#757)
jonaslagoni Sep 7, 2023
d8f6929
chore(release): v1.0.0-next.52 (#760)
asyncapi-bot Sep 7, 2023
15de3c0
feat: re add protobuff parser (#758)
GreenRover Sep 7, 2023
5e3e6c8
chore(release): v1.0.0-next.53 (#762)
asyncapi-bot Sep 7, 2023
1f77976
chore: fix playground build (#763)
jonaslagoni Sep 11, 2023
3d7e7f4
Merge branch 'master' into updatenext
derberg Sep 12, 2023
cc7bad8
fix: migrate pipelines and remove obsolete code
derberg Sep 12, 2023
75300b2
fixing deps
derberg Sep 12, 2023
e74275f
fix: sidebar problems (#766)
jonaslagoni Sep 13, 2023
409c274
chore(release): v1.0.0-next.54 (#768)
asyncapi-bot Sep 13, 2023
7664bc3
fix playground
derberg Sep 13, 2023
547e131
Merge branch 'next' into updatenext
derberg Sep 13, 2023
5ca9140
resolve conflicts
derberg Sep 13, 2023
100f41c
missing package-lock for webcomponent
derberg Sep 13, 2023
f19da7e
fix: migrate pipelines and remove obsolete code (#767)
derberg Sep 14, 2023
3a5eb3d
Update .sonarcloud.properties
derberg Sep 25, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/automerge.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ jobs:
MERGE_METHOD: "squash"
MERGE_COMMIT_MESSAGE: "{pullRequest.title} (#{pullRequest.number})"
MERGE_RETRIES: "20"
MERGE_RETRY_SLEEP: "30000"
MERGE_RETRY_SLEEP: "30000"
2 changes: 1 addition & 1 deletion .github/workflows/if-nodejs-pr-testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ jobs:
run: npm run lint --if-present
- if: steps.packagejson.outputs.exists == 'true'
name: Run release assets generation to make sure PR does not break it
run: npm run generate:assets --if-present
run: npm run generate:assets --if-present
2 changes: 1 addition & 1 deletion .github/workflows/if-nodejs-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -123,4 +123,4 @@ jobs:
fields: repo,action,workflow
text: 'Release workflow failed in release job'
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CI_FAIL_NOTIFY }}
2 changes: 1 addition & 1 deletion .github/workflows/issues-prs-notifications.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ jobs:
SLACK_WEBHOOK: ${{secrets.SLACK_GITHUB_NEWISSUEPR}}
SLACK_TITLE: 💬 New Discussion in ${{github.repository}} 💬
SLACK_MESSAGE: ${{steps.discussionmarkdown.outputs.text}}
MSG_MINIMAL: true
MSG_MINIMAL: true
2 changes: 1 addition & 1 deletion .github/workflows/lint-pr-title.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ jobs:
with:
header: pr-title-lint-error
delete: true
GITHUB_TOKEN: ${{ secrets.GH_TOKEN}}
GITHUB_TOKEN: ${{ secrets.GH_TOKEN}}
47 changes: 28 additions & 19 deletions .github/workflows/release-wc-and-playground.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,21 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
# target branch of release. More info https://docs.github.com/en/rest/reference/repos#releases
# in case release is created from release branch then we need to checkout from given branch
# if @semantic-release/github is used to publish, the minimum version is 7.2.0 for proper working
ref: ${{ github.event.release.target_commitish }}
- name: Check package-lock version
uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master
id: lockversion
- name: Setup Node.js
uses: actions/setup-node@v1
uses: actions/setup-node@v3
with:
node-version: 14
node-version: "${{ steps.lockversion.outputs.version }}"
cache: 'npm'
cache-dependency-path: '**/package-lock.json'
- name: Install latest version of library in the web-component
run: VERSION=${{github.event.release.tag_name}} npm run install:reactcomp
working-directory: ./web-component
Expand All @@ -33,37 +38,41 @@ jobs:
# When adding "bump:version" script in package.json, make sure --allow-same-version is set in case someone forgot and updated package.json manually and we want to avoide this action to fail and raise confusion
run: VERSION=${{github.event.release.tag_name}} npm run bump:webcomp:version
- name: Release web-component to NPM (@latest tag)
if: github.event.release.target_commitish != 'next'
uses: JS-DevTools/npm-publish@v1
if: github.event.release.target_commitish == 'master'
uses: JS-DevTools/npm-publish@5a85faf05d2ade2d5b6682bfe5359915d5159c6c # using 2.2.1 version https://github.com/JS-DevTools/npm-publish/releases/tag/v2.2.1
with:
token: ${{ secrets.NPM_TOKEN }}
package: ./web-component/package.json
access: public
- name: Release web-component to NPM (@next tag)
if: github.event.release.target_commitish == 'next'
uses: JS-DevTools/npm-publish@v1
- name: Release web-component to NPM (feature branch tag)
if: github.event.release.target_commitish != 'master'
uses: JS-DevTools/npm-publish@5a85faf05d2ade2d5b6682bfe5359915d5159c6c # using 2.2.1 version https://github.com/JS-DevTools/npm-publish/releases/tag/v2.2.1
with:
token: ${{ secrets.NPM_TOKEN }}
package: ./web-component/package.json
access: public
tag: next
tag: github.event.release.target_commitish

playground:
name: Release Playground
if: github.event.release.target_commitish == 'next'
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
uses: actions/checkout@v3
with:
# target branch of release. More info https://docs.github.com/en/rest/reference/repos#releases
# in case release is created from release branch then we need to checkout from given branch
# if @semantic-release/github is used to publish, the minimum version is 7.2.0 for proper working
ref: ${{ github.event.release.target_commitish }}
- name: Check package-lock version
uses: asyncapi/.github/.github/actions/get-node-version-from-package-lock@master
id: lockversion
- name: Setup Node.js
uses: actions/setup-node@v1
uses: actions/setup-node@v3
with:
node-version: 14
node-version: "${{ steps.lockversion.outputs.version }}"
cache: 'npm'
cache-dependency-path: '**/package-lock.json'
- name: Use latest version of react component in the playground
run: VERSION=${{github.event.release.tag_name}} npm run install:reactcomp
working-directory: ./playground
Expand All @@ -73,10 +82,10 @@ jobs:
run: npm run build
working-directory: ./playground
- name: Deploy GH page
uses: JamesIves/github-pages-deploy-action@3.4.2
uses: JamesIves/github-pages-deploy-action@a1ea191d508feb8485aceba848389d49f80ca2dc # use v4.4.3 https://github.com/JamesIves/github-pages-deploy-action/releases/tag/v4.4.3
with:
ACCESS_TOKEN: ${{ secrets.GH_TOKEN }}
BRANCH: gh-pages
FOLDER: playground/build
GIT_CONFIG_NAME: asyncapi-bot
GIT_CONFIG_EMAIL: info@asyncapi.io
token: ${{ secrets.GH_TOKEN }}
branch: gh-pages
folder: playground/build
git-config-name: asyncapi-bot
git-config-email: info@asyncapi.io
2 changes: 1 addition & 1 deletion .github/workflows/stale-issues-prs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ jobs:
stale-pr-label: stale
exempt-issue-labels: keep-open
exempt-pr-labels: keep-open
close-issue-reason: not_planned
close-issue-reason: not_planned
2 changes: 1 addition & 1 deletion .github/workflows/welcome-first-time-contrib.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@ jobs:
body: message,
event: 'COMMENT'
});
}
}
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@

# testing
/**/coverage
/**/cypress

# production
/**/lib
/**/build
/**/dist
/library/browser
/library/styles
/library/LICENSE
/library/README.md

Expand Down
9 changes: 9 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# List the start up tasks. Learn more https://www.gitpod.io/docs/config-start-tasks/
tasks:
- init: npm install # runs during prebuild
command: npm start

# List the ports to expose. Learn more https://www.gitpod.io/docs/config-ports/
ports:
- port: 3000
onOpen: open-preview
6 changes: 5 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@

# production
/**/lib
/**/bundles
/**/build
/**/dist
/library/browser
/library/lib
/library/styles

# misc
.DS_Store
npm-debug.log*
lerna-debug.log*
/**/*.tgz
/.github
/.github
1 change: 1 addition & 0 deletions .sonarcloud.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sonar.exclusions=library/src/components/Schema.tsx,library/src/helpers/schema.ts,library/src/containers/Error/Error.tsx,library/e2e/**/*
89 changes: 23 additions & 66 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,36 @@
# Contributing to AsyncAPI
We love your input! We want to make contributing to this project as easy and transparent as possible.
# Contributing

## Contribution recogniton
## Overview

We use [All Contributors](https://allcontributors.org/docs/en/specification) specification to handle recognitions. For more details read [this](https://github.com/asyncapi/community/blob/master/recognize-contributors.md) document.
Learn the rules to follow when you contribute code or content to this project.

## Summary of the contribution flow
## Contributing process

The following is a summary of the ideal contribution flow. Please, note that Pull Requests can also be rejected by the maintainers when appropriate.
The contributing process in this project relies on the [GitHub flow](https://guides.github.com/introduction/flow/index.html). This means that you contribute through pull requests (PRs). When adding new code or content to this project, follow these rules:

```
┌───────────────────────┐
│ │
│ Open an issue │
│ (a bug report or a │
│ feature request) │
│ │
└───────────────────────┘
┌───────────────────────┐
│ │
│ Open a Pull Request │
│ (only after issue │
│ is approved) │
│ │
└───────────────────────┘
┌───────────────────────┐
│ │
│ Your changes will │
│ be merged and │
│ published on the next │
│ release │
│ │
└───────────────────────┘
```
1. Fork this repository.
1. Make your changes. Do not forgot about:
- [Naming and architecture convention](./DEVELOPMENT.md#naming--architecture-convention)
- [Project structure](./development-guide.md/#project-structure)
- Tests
- Updating relevant documents if you add, remove, update props or configuration.
1. Create a PR.

## Code of Conduct
AsyncAPI 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.

## Our Development Process
We use Github to host code, to track issues and feature requests, as well as accept pull requests.

## Issues
[Open an issue](https://github.com/asyncapi/asyncapi/issues/new) **only** if you want to report a bug or a feature. Don't open issues for questions or support, instead join our [Slack workspace](https://www.asyncapi.com/slack-invite) and ask there. Don't forget to follow our [Slack Etiquette](https://github.com/asyncapi/community/blob/master/slack-etiquette.md) while interacting with community members! It's more likely you'll get help, and much faster!

## Bug Reports and Feature Requests

Please use our issues templates that provide you with hints on what information we need from you to help you out.

## Pull Requests

**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. Get familiar with our document that explains [Git workflow](https://github.com/asyncapi/community/blob/master/git-workflow.md) used in our repositories.
PRs are very welcome. However, if you want to add a new feature, use GitHub issues to discuss your ideas first.

## Conventional commits

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/).

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:

- `fix: ` prefix in the title indicates that PR is a bug fix and PATCH release must be triggered.
- `feat: ` prefix in the title indicates that PR is a feature and MINOR release must be triggered.
- `docs: ` prefix in the title indicates that PR is only related to the documentation and there is no need to trigger release.
- `chore: ` prefix in the title indicates that PR is only related to cleanup in the project and there is no need to trigger release.
- `test: ` prefix in the title indicates that PR is only related to tests and there is no need to trigger release.
- `refactor: ` prefix in the title indicates that PR is only related to refactoring and there is no need to trigger release.

What about MAJOR release? just add `!` to the prefix, like `fix!: ` or `refactor!: `
This project follows the [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/).

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).
A PR 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 the PR. You can also use this cheatsheet:

Happy contributing :heart:
- `fix: ` prefix in the title indicates that a PR is a bug fix and the PATCH release must be triggered.
- `feat: ` prefix in the title indicates that a PR is a feature and the MINOR release must be triggered.
- `docs: ` prefix in the title indicates that a PR is only related to the documentation and there is no need to trigger a release.
- `chore: ` prefix in the title indicates that a PR is only related to the project cleanup and there is no need to trigger a release.
- `test: ` prefix in the title indicates that a PR is only related to tests and there is no need to trigger a release.
- `refactor: ` prefix in the title indicates that a PR is only related to refactoring and there is no need to trigger a release.

## License
When you submit changes, your submissions are understood to be under the same [Apache 2.0 License](https://github.com/asyncapi/asyncapi/blob/master/LICENSE) that covers the project. Feel free to [contact the maintainers](https://www.asyncapi.com/slack-invite) if that's a concern.
For a MAJOR release, just add `!` to the prefix, like `fix!: ` or `refactor!: `.

## References
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md).
A prefix that follows the specification is not enough though. Remember that the title must be clear, descriptive, and in the [imperative mood](https://chris.beams.io/posts/git-commit/#imperative).
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@
identification within third-party archives.

Copyright (c) 2018-2019 SAP SE or an SAP affiliate company. All rights reserved.
Copyright (c) 2020-2021 AsyncAPI contributors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
Loading
Loading