Skip to content
Open
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG] <Brief description of the issue>"
labels: ''
assignees: koltsov-iv

---

**Describe the bug**
A clear and concise description of what the bug is. Include whether the issue occurs in the core library, a specific framework wrapper (e.g., React), or the example application.

**Library and Version**
- Core library version: [e.g., 1.0.0]
- Wrapper library (if applicable): [e.g., make-traffic-integration-react-wrapper]
- Wrapper version: [e.g., 1.0.0]
- Node.js version: [e.g., 18.0.0]

**To Reproduce**
Steps to reproduce the behavior:
1. Initialize TaskManagerApp with [describe your configuration]
2. Call [method name, e.g., `getTasks()`, `claimProcess()`]
3. [Any additional steps]
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Actual behavior**
What actually happened instead. Include any error messages or unexpected output.

**Code Example**
If applicable, provide a minimal code example that reproduces the issue:

```typescript
// Your code here
import { TaskManagerApp } from "make-traffic-integration-core";

const appConfig = {
apiUrl: 'https://...',
appKey: 'your-app-key',
};

const taskManager = new TaskManagerApp(appConfig);
// Steps to reproduce the bug
```

**Error Messages and Logs**
If applicable, include:
- Full error stack trace
- Console logs
- Network request/response details (from browser DevTools)
- Event subscription callback errors

**Environment**
- **Operating System**: [e.g., macOS, Windows, Linux]
- **Browser** (if applicable): [e.g., Chrome, Firefox, Safari]
- **Browser Version** (if applicable): [e.g., 120.0]
- **Package Manager**: [e.g., npm, yarn, pnpm]
- **TypeScript Version** (if using TypeScript): [e.g., 5.0]

**Affected Components**
- [ ] Core library (`make-traffic-integration-core`)
- [ ] React wrapper (`make-traffic-integration-react-wrapper`)
- [ ] Example application (`examples/react-app`)
- [ ] Other: [please specify]

**API Integration Details** (if relevant)
- API URL being used: [e.g., https://make-traffic-integration.dot.com]
- User ID format: [e.g., string, UUID]
- Task type/category: [if applicable]

**Screenshots or Network Traces**
If applicable, add screenshots or network traces to help explain your problem. Include:
- Browser DevTools Network tab showing API requests/responses
- Console error messages
- UI state when the bug occurs

**Additional context**
Add any other context about the problem here, such as:
- Whether this is a regression (worked in a previous version)
- Frequency of occurrence (always, intermittent, etc.)
- Any workarounds you've found
- Related issues or discussions
57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
name: Feature request
about: Suggest an idea for this project
title: "[FEATURE] <Brief description of the requested feature>"
labels: ''
assignees: koltsov-iv

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is or what limitation you're experiencing. For example: "I'm always frustrated when [the task manager doesn't support batch operations]" or "Currently, there's no way to [filter tasks by category]."

**Describe the solution you'd like**
A clear and concise description of what you want to happen. Include details such as:
- Which component(s) would be affected: core library, React wrapper, or both?
- What new method(s) or functionality would be needed?
- How would this integrate with existing APIs like `TaskManagerApp`, `getTasks()`, `claimProcess()`, etc.?
- Would this require new event types?

**Use Case and Impact**
Explain the use case for this feature:
- How would this improve the developer experience?
- What problems does it solve?
- How many users/projects would benefit from this feature?
- Is this a critical feature or a nice-to-have enhancement?

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered. For example:
- Workarounds you're currently using
- Other libraries or approaches that provide similar functionality
- Why those alternatives are not sufficient

**Implementation Suggestions** (optional)
If you have ideas about how this could be implemented, share them:
- Proposed API design or method signatures
- Changes to existing interfaces or types
- New event types that might be needed
- Impact on the React wrapper or other framework-specific implementations

**Affected Components**
- [ ] Core library (`make-traffic-integration-core`)
- [ ] React wrapper (`make-traffic-integration-react-wrapper`)
- [ ] Example application (`examples/react-app`)
- [ ] Documentation
- [ ] Other: [please specify]

**Priority and Scope**
- **Priority**: [Low / Medium / High]
- **Scope**: [Small enhancement / Medium feature / Large feature]
- **Breaking Changes**: Would this require breaking changes to existing APIs? [Yes / No]

**Additional context**
Add any other context, screenshots, or mockups about the feature request here. Include:
- Links to related issues or discussions
- Examples of how similar features are implemented in other libraries
- Any relevant code snippets or configuration examples
- User feedback or community requests
35 changes: 35 additions & 0 deletions .github/developer-certificate-of-origin
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or

(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or

(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.

(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
36 changes: 36 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## Resolves
Closes #<!-- related GitHub issue number -->

## Summary
Brief description of changes and why they're needed.

## Type of Change
- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## Affected Components
- [ ] Core library
- [ ] React wrapper
- [ ] Example application
- [ ] Other: [specify]

## Changes
- What was changed?
- What new methods/types were added (if any)?

## Testing
- [ ] Tests added/updated
- [ ] Manual testing performed
- [ ] No tests needed

## API Changes (if applicable)
Describe any changes to `TaskManagerApp`, method signatures, or `Events`.

## Checklist
- [ ] Code is properly formatted
- [ ] All commits are signed
- [ ] Tests included/updated or not needed
- [ ] Documentation updated or not required
- [ ] No breaking changes (or documented if present)
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
community@make.services.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributing to Make Traffic Integration JS Library

The following is a set of rules and guidelines for contributing to this repo. Please feel free to propose changes to this document in a pull request.

## Submitting issues

If you have questions about integrating Make Traffic Integration JS Library into your app, or need help, please contact us via community@make.services

### Guidelines
* Please search the existing issues first, it's likely that your issue was already reported or even fixed.
- Go to the main page of the repository, click "issues" and type any word in the top search/command bar.
- You can also filter by appending e. g. "state:open" to the search string.
- More info on [search syntax within GitHub](https://help.github.com/articles/searching-issues)

## Contributing to Make Traffic Integration JS Library

All contributions to this repository are considered to be licensed under Apache License 2.0.

Workflow for bug fixes:
* Check open issues and unmerged pull requests to make sure the topic is not already covered elsewhere
* Fork the repository
* Do your changes on your fork
* Make sure to add or update relevant test cases
* Create a pull request, with a suitable title and description, referring to the related issue

### Sign your work

We use the Developer Certificate of Origin (DCO) as a additional safeguard
for the Make Traffic Integration JS Library project. This is a well established and widely used
mechanism to assure contributors have confirmed their right to license
their contribution under the project's license.
Please read [developer-certificate-of-origin](https://github.com/make-software/make-traffic-integration-lib/blob/master/.github/developer-certificate-of-origin).
If you can certify it, then just add a line to every git commit message:

````
Signed-off-by: Random J Developer <random@developer.example.org>
````

Use your real name (sorry, no pseudonyms or anonymous contributions).
If you set your `user.name` and `user.email` git configs, you can sign your
commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases)
like `git config --global alias.ci 'commit -s'`. Now you can commit with
`git ci` and the commit will be signed.
Loading