Skip to content

Commit aaa9c8c

Browse files
jwulfjwulf
committed
WIP
Signed-off-by: Josh Wulf <josh@magikcraft.io> @magikcraft.io>
1 parent b31600b commit aaa9c8c

5 files changed

+228
-55
lines changed

‎.github/ISSUE_TEMPLATE.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Issue tracker is **ONLY** used for reporting bugs. New features and questions should be discussed on [our slack channel](https://zeebe-slack-invite.herokuapp.com/).
2+
3+
<!--- Provide a general summary of the issue in the Title above -->
4+
5+
## Expected Behavior
6+
<!--- Tell us what should happen -->
7+
8+
## Current Behavior
9+
<!--- Tell us what happens instead of the expected behavior -->
10+
11+
## Possible Solution
12+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
13+
14+
## Steps to Reproduce
15+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
16+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
17+
1.
18+
2.
19+
3.
20+
4.
21+
22+
## Context (Environment)
23+
<!--- How has this issue affected you? What are you trying to accomplish? -->
24+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
25+
26+
<!--- Provide a general summary of the issue in the Title above -->
27+
28+
## Detailed Description
29+
<!--- Provide a detailed description of the change or addition you are proposing -->
30+
31+
## Possible Implementation
32+
<!--- Not obligatory, but suggest an idea for implementing addition or change -->

‎.github/PULL_REQUEST_TEMPLATE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Fixes #
2+
3+
## Proposed Changes
4+
5+
-
6+
-
7+
-

‎CODE_OF_CONDUCT.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
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, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
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 code-of-conduct@zeebe.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

‎CONTRIBUTING.md

+114-55
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,132 @@
1-
# Contributor Covenant Code of Conduct
1+
# Contributing to this project
22

3-
## Our Pledge
3+
We welcome your contributions to this project.
44

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, gender identity and expression, level of experience,
9-
nationality, personal appearance, race, religion, or sexual identity and
10-
orientation.
5+
It could be:
116

12-
## Our Standards
7+
* a [bug report](#bug-reports) in a GitHub issue
8+
* a [feature request](#feature-requests) in a GitHub issue
9+
* a [fix to documentation](#fix-to-documentation)
10+
* a code contribution to [address an existing bug or feature request](#code-contribution-for-an-existing-issue)
11+
* a code contribution to [fix a bug that you found](#code-contribution-for-a-new-bug)
12+
* a code contribution to [add a new feature](#code-contribution-for-a-new-feature)
1313

14-
Examples of behavior that contributes to creating a positive environment
15-
include:
14+
By contributing to this project, you license your contribution under the same [license](#license) that we use.
1615

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
16+
## Bug reports
2217

23-
Examples of unacceptable behavior by participants include:
18+
Before opening a bug report, please search the existing GitHub issues to see if it has already been reported.
2419

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
20+
### Existing bug issues
3321

34-
## Our Responsibilities
22+
If you find an existing bug report, please give the original report a thumbs-up. This helps us to understand how many people are affected by it.
3523

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.
24+
If you have additional information that can help us understand the behaviour of the bug, how it presents in your configuration, or its impact, please add that as a comment.
3925

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.
26+
### New bug reports
4527

46-
## Scope
28+
If no issue already exists for the bug, please create a new one.
4729

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.
30+
When creating a bug report, please fill out the template. What really helps us are the steps for us to be able reproduce the problem in front of us.
5431

55-
## Enforcement
32+
To generate these, start from nothing, and document the steps required to set up a project that shows the bug. If you create such a project as a new GitHub repo, you will have a Minimal Reproducible Example. We can then check out that project and see the bug in front of us immediately. This will increase the speed that we can address the issue. It will also help you isolate the actual issue, and sometimes to fix it.
5633

57-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at code-of-conduct@zeebe.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.
34+
## Feature Requests
6335

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.
36+
Before opening a feature request, please search the existing GitHub issues to see if it already exists.
6737

68-
## Attribution
38+
### Existing feature requests
6939

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
40+
If you find an existing feature request, please give the original report a thumbs-up. This helps us to understand how many people want it.
7241

73-
[homepage]: https://www.contributor-covenant.org
42+
If you have additional information that can help us understand the behaviour you need, or another use case not covered in the existing comments, please add that as a comment.
43+
44+
### New feature requests
45+
46+
If no issue already exists for the feature request, please create a new one.
47+
48+
When creating a feature request, please fill out the template. What really helps us are both the motivation for the feature (what is your use-case and what you want to achieve), as well as what you would like the feature to be. Sometimes there is an existing way to accomplish what you want, and we may be able to recommend that.
49+
50+
If there is no existing way to do it, then understanding the use-case that motivates the feature request helps us to triage it, and also to design the feature implementation.
51+
52+
## Fix to documentation
53+
54+
Maybe while getting started, you notice a step or a dependency that we missed out, or something that would have helped you. In that case, opening a Pull Request with a patch that adds it will help others when they get started. They may never know to thank you for it, but we will!
55+
56+
Please read the [Code Style Guidelines](#code-style-guidelines) and [Commit Message Guidelines](#commit-message-guidelines) to ensure that your code matches the coding style of the project. This makes it easier for us to merge your contribution.
57+
58+
## Code contribution for an existing issue
59+
60+
Maybe you patch an existing bug, or implement a requested feature for yourself - without waiting for us to get to it. You can contribute that to the codebase as a pull request. This way, you don't end up maintaining a separate fork.
61+
62+
See the section [Running a development version](#running-a-development-version) for instructions on how to use your fork locally to test your changes.
63+
64+
Please read the [Code Style Guidelines](#code-style-guidelines) and [Commit Message Guidelines](#commit-message-guidelines) to ensure that your code matches the coding style of the project. This makes it easier for us to merge your contribution.
65+
66+
If you are implementing a feature, it is a good idea to comment on the issue with your proposed approach. Early feedback and coordination increases the chances that we can merge it.
67+
68+
## Code contribution for a new bug
69+
70+
Maybe you find a bug, dig into the source code, and patch it for yourself. See the section [Running a development version](#running-a-development-version) for instructions on how to use your fork locally to test your changes.
71+
72+
See the section [Running a development version](#running-a-development-version) for instructions on how to use your fork locally to test your changes.
73+
74+
Please read the [Code Style Guidelines](#code-style-guidelines) and [Commit Message Guidelines](#commit-message-guidelines) to ensure that your code matches the coding style of the project. This makes it easier for us to merge your contribution.
75+
76+
When you have a working fork, create a Pull Request, and open a new GitHub issue that describes the issue that you've fixed. If you make the pull request title for your fix "Fixes #${GitHub Issue Number}", then the bug report will be automatically closed when we merge it.
77+
78+
## Code contribution for a new feature
79+
80+
Maybe you implement a missing feature that you want. That's the beauty of open source - we co-create it. To get that merged into the code base, open a feature request issue. It's a good idea to discuss your proposed approach with us in an feature request issue. We might be planning to do it already and have an idea, or maybe we can help you identify the best approach given our familiarity with the codebase.
81+
82+
See the section [Running a development version](#running-a-development-version) for instructions on how to use your fork locally to test your changes.
83+
84+
Please read the [Code Style Guidelines](#code-style-guidelines) and [Commit Message Guidelines](#commit-message-guidelines) to ensure that your code matches the coding style of the project. This makes it easier for us to merge your contribution.
85+
86+
When you have a working fork, create a Pull Request. If you make the pull request title for your fix "Fixes #${GitHub Issue Number}", then the feature request will be automatically closed when we merge it.
87+
88+
## Code Style Guidelines
89+
90+
The code formatting guidelines are documented in the `.editorconfig` and `.prettier.config.js` files in the root of the project.
91+
92+
Code is linted automatically in a pre-commit hook.
93+
94+
## Commit Message Guidelines
95+
96+
Make them descriptive.
97+
98+
If merging a commit will close an issue, then put "Fixes #${issue_number}" in the message.
99+
100+
## Running a development version
101+
102+
To run a local development version of the library, clone this repo or a fork to your local machine, then install dependencies:
103+
104+
```bash
105+
npm i
106+
```
107+
108+
To use your local version of `zeebe-node` in another project, use [npm link](https://docs.npmjs.com/cli/link). This will symlink your development checkout into another project.
109+
110+
In the your development checkout of `zeebe-node`, run the following command:
111+
112+
```bash
113+
npm link
114+
```
115+
116+
In the other project, to use the development checkout of `zeebe-node`, run:
117+
118+
```bash
119+
npm link zeebe-node
120+
```
121+
122+
Note that you need to relink the local package with this command in your project any time that you run `npm i` in the project. Installing packages in the project replaces the symlink with the package from npm.
123+
124+
## License
125+
126+
This project is licensed under the [Apache 2.0]((https://opensource.org/licenses/Apache-2.0)) license.
127+
128+
Any contributions you make to this project will be licensed under this license.
129+
130+
## Code of Conduct
131+
132+
This project adheres to the Contributor Covenant [Code of Conduct](https://github.com/zeebe-io/zeebe-client-node-js/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [code-of-conduct@zeebe.io](code-of-conduct@zeebe.io).

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ Get a hosted instance of Zeebe on [Camunda Cloud](https://camunda.io).
8787

8888
To enable that the client libraries can be easily supported to the Zeebe server we map the version numbers, so that Major, Minor match the server application. Patches are independent and indicate client updates.
8989

90+
NPM Package version 0.24.x supports Zeebe 0.22.x and above
91+
9092
NPM Package version 0.23.x supports Zeebe 0.22.x and above
9193

9294
NPM Package version 0.22.x supports Zeebe 0.22.x

0 commit comments

Comments
 (0)