Contributing to DDASH
The following is a set of guidelines for contributing to DDASH. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Table Of Contents
- Git Commit Messages
- Python Styleguide
- CoffeeScript Styleguide
- Specs Styleguide
- Documentation Styleguide
Code of Conduct
This project and everyone participating in it is governed by the DDASH Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to firstname.lastname@example.org.
How Can I Contribute?
This section guides you through submitting a bug report for DDASH. Following these guidelines helps maintainers and the community understand your report
How Do I Submit A (Good) Bug Report?
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 DDASH, e.g. the command line interface or the GUI, and which network you connected to. 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. You can use this tool to record GIFs on macOS and Windows, and this tool or this tool on Linux.
- If you're reporting that DDASH crashed, include a crash report with a stack trace.
- 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 DDASH) or was this always a problem?
- If the problem started happening recently, can you reproduce the problem in an older version of DDASH?
- 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 DDASH are you using?
- What's the name and version of the OS you're using?
- Are you running DDASH in a virtual machine? If so, which VM software are you using and which operating system?
- **Which dependencies do you have installed?
- Are you connecting to the default (Black Swan) private network, the main Ethereum network, or another private network?
This section guides you through submitting an enhancement suggestion for DDASH, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion
How Do I Submit A (Good) Enhancement Suggestion?
Enhancement suggestions are tracked as GitHub issues. Create an issue in the DDASH repository 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 DDASH 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 DDASH users.
- Specify the name and version of the OS you're using.
Your First Code Contribution
Unsure where to begin contributing to DDASH? You can start by looking through these
- [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
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.
- Fill in the required template
- Do not include issue numbers in the PR title
- Include screenshots and animated GIFs in your pull request whenever pertinent to the GUI.
- Follow the Python and Solidity styleguides.
- Document new code based on the Documentation Styleguide
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:
:mountain_cableway:when improving the GUI
:money_with_wingswhen improving SwapCoin contract code
:floppy_disk:when improving the DDASH command line interface
:satellite:when improving the DDASH networking protocol
: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
:bug:when fixing a bug
:fire:when removing code or files
:white_check_mark:when adding tests
:lock:when dealing with security
Python should adhere to [Python PEP 8 Style Guide (https://www.python.org/dev/peps/pep-0008/).
Solidity contract code should adhere to [Solidity Style Guide] (http://solidity.readthedocs.io/en/develop/style-guide.html).