|
| 1 | +# Contributing to string-case-swift |
| 2 | + |
| 3 | +First off, thanks for taking the time to contribute! :tada::+1: |
| 4 | + |
| 5 | +The following is a set of guidelines for contributing to Digipolitan and its packages, which are hosted in the [Digipolitan Organization](https://github.com/digipolitan) on GitHub. |
| 6 | +These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. |
| 7 | + |
| 8 | +#### Table Of Contents |
| 9 | + |
| 10 | +[What should I know before I get started?](#what-should-i-know-before-i-get-started) |
| 11 | + * [Code of Conduct](#code-of-conduct) |
| 12 | + |
| 13 | +[How Can I Contribute?](#how-can-i-contribute) |
| 14 | + * [Reporting Bugs](#reporting-bugs) |
| 15 | + |
| 16 | +## What should I know before I get started? |
| 17 | + |
| 18 | +### Code of Conduct |
| 19 | + |
| 20 | +This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). |
| 21 | +By participating, you are expected to uphold this code. |
| 22 | +Please report unacceptable behavior to [[email protected]](mailto:[email protected]). |
| 23 | + |
| 24 | +### Reporting Bugs |
| 25 | + |
| 26 | +This section guides you through submitting a bug report for Digipolitan. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:. |
| 27 | + |
| 28 | +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). If you'd like, you can use [this template](#template-for-submitting-bug-reports) to structure the information. |
| 29 | + |
| 30 | +#### Before Submitting A Bug Report |
| 31 | + |
| 32 | +* **Perform a [search](https://github.com/issues?q=+is%3Aissue+user%3Adigipolitan)** to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one. |
| 33 | + |
| 34 | +#### How Do I Submit A (Good) Bug Report? |
| 35 | + |
| 36 | +Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). After you've determined |
| 37 | + |
| 38 | +Explain the problem and include additional details to help maintainers reproduce the problem: |
| 39 | + |
| 40 | +* **Use a clear and descriptive title** for the issue to identify the problem. |
| 41 | +* **Describe the exact steps which reproduce the problem** in as many details as possible. |
| 42 | +* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). |
| 43 | +* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. |
| 44 | +* **Explain which behavior you expected to see instead and why.** |
| 45 | +* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. |
| 46 | +* **If you're reporting that string-case-swift crashed**, include a crash report with a stack trace from the operating system. On iOS, the crash report is available in Xcode, on macOS, the crash report will be available in `Console.app` under "Diagnostic and usage information" > "User diagnostic reports". Include the crash report in the issue in a [code block](https://help.github.com/articles/markdown-basics/#multiple-lines), a [file attachment](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/), or put it in a [gist](https://gist.github.com/) and provide link to that gist. |
| 47 | +* **If the problem is related to performance**, include a CPU profile capture and a screenshot with your report. |
| 48 | +* **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. |
| 49 | + |
| 50 | +Provide more context by answering these questions: |
| 51 | + |
| 52 | +* **Did the problem start happening recently** (e.g. after updating to a new version of string-case-swift) or was this always a problem? |
| 53 | +* If the problem started happening recently, **can you reproduce the problem in an older version of string-case-swift ?** What's the most recent version in which the problem doesn't happen? You can download older versions of string-case-swift from [the releases page](https://github.com/digipolitan/string-case-swift/releases). |
| 54 | +* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens. |
| 55 | + |
| 56 | +Include details about your configuration and environment: |
| 57 | + |
| 58 | +* **Which version of string-case-swift are you using? |
| 59 | +* **What's the name and version of the macOS or iOS you're using**? |
| 60 | + |
| 61 | +#### Template For Submitting Bug Reports |
| 62 | + |
| 63 | + [Short description of problem here] |
| 64 | + |
| 65 | + **Reproduction Steps:** |
| 66 | + |
| 67 | + 1. [First Step] |
| 68 | + 2. [Second Step] |
| 69 | + 3. [Other Steps...] |
| 70 | + |
| 71 | + **Expected behavior:** |
| 72 | + |
| 73 | + [Describe expected behavior here] |
| 74 | + |
| 75 | + **Observed behavior:** |
| 76 | + |
| 77 | + [Describe observed behavior here] |
| 78 | + |
| 79 | + **Screenshots and GIFs** |
| 80 | + |
| 81 | +  |
| 82 | + |
| 83 | + **string-case-swift version:** [Enter string-case-swift version here] |
| 84 | + **OS and version:** [Enter macOS / iOS / linux name and version here] |
| 85 | + |
| 86 | + **Installed packages:** |
| 87 | + |
| 88 | + [List of installed packages here] |
| 89 | + |
| 90 | + **Additional information:** |
| 91 | + |
| 92 | + * Problem started happening recently, didn't happen in an older version of string-case-swift: [Yes/No] |
| 93 | + * Problem can be reliably reproduced, doesn't happen randomly: [Yes/No] |
| 94 | + * Problem happens with all files and projects, not only some files or projects: [Yes/No] |
0 commit comments