First off, thanks for taking the time to contribute! 🎉
The following is a set of guidelines for contributing to Artizenand its repositories, which are hosted in the Artizen Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
By participating, you are expected to uphold this code. Please report unacceptable behavior to admin@artizen.fund.
Artizen is a big project with many components, check tech docs
Reporting bugs is always welcome. Use the repository issue to check current bugs and open new issues.
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 Atom, e.g. which command exactly you used in the terminal, or how you started Atom otherwise. When listing steps, don't just say what you did, but explain how you did it. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Atom command, and if so which one?
- 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.
- If you're reporting that Atom crashed, include a crash report with a stack trace from the operating system. On macOS, the crash report will be available in
Console.appunder "Diagnostic and usage information" > "User diagnostic reports". 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 or memory, include a CPU profile capture with your report.
- If Chrome's developer tools pane is shown without you triggering it, that normally means that you have a syntax error in one of your themes.
- 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.
This section guides you through submitting an enhancement suggestion for Artizen, 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 Wiki as you might find out that you don't need to create one.
Artizen and all repositories can be developed locally. For instructions on how to do this, see the information in each repository
Follow Artizen's code style