The following is a set of guidelines for contributing to Typewriter. These are just guidelines, not rules, use your best judgement and feel free to propose changes as a pull request.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.
This section guides you through submitting a bug report for Typewriter. 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 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. If you'd like, you can use this template to structure the information.
- Check the [FAQs on the forum](TO-DO: Addline) for a list of common questions and problems.
- Perform a cursory search 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.
Bugs are tracked as GitHub issues. After going through the necessary first steps, you can create an issue on and provide the following information.
Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible. For example, start by explaining how you started Typewriter, e.g. which command exactly you used in the terminal, or how you started Typewriter otherwise. When listing steps, don't just say what you did, but explain how you did it.
- 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.
- 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 you use the keyboard while following the steps, record the GIF with the Keybinding Resolver shown. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- If you're reporting a crash, include a crash report with a stack trace from the operating system. Include the crash report in the issue in a code block, a file attachment, or put it in a gist and provide link to that gist.
- If the problem is related to performance, include a CPU profile capture and a screenshot with your report.
- 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.
Provide more context by answering these questions:
- Did the problem start happening recently (e.g. after updating to a new version of Typewriter) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of Typewriter? What's the most recent version in which the problem doesn't happen? (TO-DO: Add links to older versions of Typewriter)
- Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
Include details about your configuration and environment:
- Which version of Typewriter are you using? (TO-DO: Add how to figure out the exact version of Typewriter)
- Are you running Typewriter in a virtual machine? If so, which VM software are you using and which operating systems and versions are used for the host and the guest?
[Short description of problem here]
**Reproduction Steps:**
1. [First Step]
2. [Second Step]
3. [Other Steps...]
**Expected behavior:**
[Describe expected behavior here]
**Observed behavior:**
[Describe observed behavior here]
**Screenshots and GIFs**
**Typewriter version:** [Enter Typewriter version here]
**OS and version:** [Enter OS name and version here]
**Additional information:**
* Problem started happening recently, didn't happen in an older version of Typewriter: [Yes/No]
* Problem can be reliably reproduced, doesn't happen randomly: [Yes/No]
This section guides you through submitting an enhancement suggestion for Typewriter, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. If you'd like, you can use this template to structure the information.
- Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- TODO: Add more pre-requisites for enhancement suggestion
Enhancement suggestions are tracked as GitHub issues. After going through the necessary first steps, you can create an issue on 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 many details as possible.
- Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
- Describe the current behavior and explain which behavior you expected to see instead and why.
- Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of Typewriter which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- Explain why this enhancement would be useful to most Typewriter users.
- List some other similar open source projects or applications where this enhancement exists.
- Specify which version of Typewriter you're using. (TODO: Add how to figure out version of Typewriter)
- Specify the name and version of the OS you're using.
[Short description of suggestion]
**Steps which explain the enhancement**
1. [First Step]
2. [Second Step]
3. [Other Steps...]
**Current and suggested behavior**
[Describe current and suggested behavior here]
**Why would the enhancement be useful to most users**
[Explain why the enhancement would be useful to most users]
[List some other similar open source projects or applications where this enhancement exists]
**Screenshots and GIFs**
**Typewriter Version:** [Enter Typewriter version here]
**OS and Version:** [Enter OS name and version here]
Unsure where to begin contributing to Typewriter? You can start by looking through these `beginner` and `help-wanted` issues:
* [Beginner issues][beginner] - issues which should only require a few lines of code, and a test or two.
* [Help wanted issues][help-wanted] - issues which should be a bit more involved than `beginner` issues.
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
If you want to read about using Typewriter, you can have a quick look through these resources in the Wiki.
- Include screenshots and animated GIFs in your pull request whenever possible.
- End files with a newline.
- TODO: Add more pre-requisites for Pull Requests.
- TODO: Add Documentation Styleguide.
- 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
- When only changing documentation, include
[ci skip]in the commit description - Consider starting the commit message with an applicable emoji: (TODO: Needs review)
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐧
:penguin:when fixing something on Linux - 🍎
:apple:when fixing something on macOS - 🏁
:checkered_flag:when fixing something on Windows - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
: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
- 🎨
When contributing to an open source project you might hit some problems, have some of those Eureka moments, and you simply might want to have a quick chat with us. You can always reach out to us at info@typewriter-editor.com and you are always welcome to join the Typewriter Community banter on our Gitter channel at https://gitter.im/Typewriter/Lobby
As a young open source organization we continue to learn a lot along the way. Writing this Contributors Guidelines was one such learning experience, where we learnt so much from the Contributors Guidelines of one of our favorite open source projects, Atom.