ticket-hero-sdk

# Contributing to Ticket Hero SDK Thank you for considering contributing to Ticket Hero SDK! We welcome contributions from developers of all skill levels. ## Code of Conduct By participating in this project, you are expected to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). ## How Can I Contribute? ### Reporting Bugs This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports. Before creating bug reports, please check [this list](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). #### Before Submitting A Bug Report * **Check the [discussions](https://github.com/[yourusername]/ticket-hero-sdk/discussions)** for a list of common questions and problems. * **Perform a [cursory search](https://github.com/search?q=+is%3Aissue+repo%3A[yourusername]/ticket-hero-sdk)** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one. #### How Do I Submit A (Good) Bug Report? Bugs are tracked as [GitHub issues](https://github.com/[yourusername]/ticket-hero-sdk/issues). Create an issue and provide the following information: * **Use a clear and descriptive title** for the issue to identify the problem. * **Describe the exact steps which reproduce the problem** in as much detail as possible. * **Provide specific examples to demonstrate the steps**. * **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. * **Explain which behavior you expected to see instead and why.** * **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. * **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below. ### Suggesting Enhancements This section guides you through submitting an enhancement suggestion, including completely new features and minor improvements to existing functionality. #### Before Submitting An Enhancement Suggestion * **Check if the enhancement has already been suggested** by searching for existing issues. * **Determine which repository the enhancement should be suggested in** (e.g., core functionality vs documentation). #### How Do I Submit A (Good) Enhancement Suggestion? Enhancement suggestions are tracked as [GitHub issues](https://github.com/[yourusername]/ticket-hero-sdk/issues). Create an issue and provide the following information: * **Use a clear and descriptive title** for the issue to identify the suggestion. * **Provide a step-by-step description of the suggested enhancement** in as much detail as possible. * **Provide specific examples to demonstrate the steps**. * **Describe the current behavior** and **explain which behavior you expected to see instead** and why. * **Explain why this enhancement would be useful** to most Ticket Hero SDK users. * **Specify which version of Ticket Hero SDK you're using.** * **Specify the name and version of the OS you're using.** ### Your First Code Contribution Unsure where to begin contributing? You can start by looking through these `beginner` and `help-wanted` issues: * [Beginner issues](https://github.com/[yourusername]/ticket-hero-sdk/labels/beginner) - issues which should only require a few lines of code, and a test or two. * [Help wanted issues](https://github.com/[yourusername]/ticket-hero-sdk/labels/help%20wanted) - issues which should be a bit more involved than `beginner` issues. ### Pull Requests The process described here has several goals: - Maintain Ticket Hero SDK's quality - Fix problems that are important to users - Engage the community in working toward the best possible Ticket Hero SDK - Enable a sustainable system for maintainers to review contributions Please follow these steps to have your contribution considered by the maintainers: 1. Follow all instructions in [the template](PULL_REQUEST_TEMPLATE.md) 2. Follow the [styleguides](#styleguides) 3. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. ## Styleguides ### Git Commit Messages * Use the present tense ("Add feature" not "Added feature") * Use the imperative mood ("Move cursor to..." not "Moves cursor to...") * Limit the first line to 72 characters or less * Reference issues and pull requests liberally after the first line * Consider starting the commit message with an applicable emoji: * 🎨 `:art:` when improving the format/structure of the code * 🐎 `:racehorse:` when improving performance * 🚱 `:non-potable_water:` when plugging memory leaks * 📝 `:memo:` when writing docs * 🐛 `:bug:` when fixing a bug * 🔥 `:fire:` when removing code or files * ✅ `:white_check_mark:` when adding tests * 🔒 `:lock:` when dealing with security * ⬆️ `:arrow_up:` when upgrading dependencies * ⬇️ `:arrow_down:` when downgrading dependencies * 👕 `:shirt:` when removing linter warnings ### JavaScript Styleguide * 2 spaces for indentation * Use semicolons * Prefer `const` over `let` and `let` over `var` * 80 character line length * Use single quotes for strings * Prefer template strings over string concatenation * Use camelCase for variables and functions * Use PascalCase for classes * Use UPPERCASE for constants * Add proper JSDoc comments for functions and classes ## Additional Notes ### Issue and Pull Request Labels This section lists the labels we use to help us track and manage issues and pull requests. * `bug` - Issues that are bugs * `documentation` - Issues or PRs related to documentation * `duplicate` - Issues that are duplicates of other issues * `enhancement` - Issues that request a new feature * `good first issue` - Good for newcomers * `help wanted` - Extra attention is needed * `invalid` - Issues that are invalid or non-reproducible * `question` - Issues that are questions * `wontfix` - Issues that will not be worked on ## Thank You! Your contributions to open source, large or small, make projects like this possible. Thank you for taking the time to contribute.