Skip to content

Latest commit

 

History

History
111 lines (69 loc) · 6.23 KB

CONTRIBUTING.md

File metadata and controls

111 lines (69 loc) · 6.23 KB
Raw

Contributing to DAPPICOM

DAPPICOM is an open-source project made possible by contributors like you <3 let's build something really great together!

if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation and contribute to DAPPICOM's success:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

I Have a Question

If you want to ask a question, you can message us in the #dappicom channel on the Tonk Discord. Please do take a look at the Roadmap and Product Flow Technical Document.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report.

  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the Issues.
  • Collect information about the bug:
  • Stack trace (Traceback)
  • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
  • Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
  • Possibly your input and the output
  • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue using the "bug template". (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)

Once it's filed:

  • The project team will label the issue accordingly.
  • A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as needs-repro. Bugs with the needs-repro tag will not be addressed until they are reproduced.
  • If the team is able to reproduce the issue, it will be marked needs-fix, as well as possibly other tags (such as critical), and the issue will be left to be implemented by someone.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for CONTRIBUTING.md, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Perform a 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.
  • At this stage of the project, idea generation is a good thing not a bad thing, so feel free to throw out whatever kind of wacky ideas you have. These will be prioritized by the maintaining team with labels, but there's no such thing as a "bad idea" even if we decide it's out of scope for the project long term.

Core Contributions

There are several tracks of work at the moment to complete the "Foundation V0" part of the TECHNICAL.md roadmap. These tracks of work have been broken into milestones to aggregate related issues

They are

If you would like to contribute to any of these core pieces, please find the issue and either follow the instructions on the issue (if it's a tracker) or comment on the issue that you would like to take it on.

Your First Code Contribution

If a Core contribution seems too daunting, then you can search the Issues for those labeled with "good first issue".

Styleguides

Commit Messages

For PRs we use the conventional commits naming convention.

Join The Project Team

If you would like to join the project team, start contributing! If contributions become more regular and you can prove a solid knowledge of the subject matter and codebase, then that makes you a good candidate for joining the project team and we will reach out to you.

Attribution

This guide is based on the contributing.md. Make your own!