bigchaindb
/
bigchaindb
mirror of https://github.com/bigchaindb/bigchaindb.git
1
0
Fork 0
Code Releases Activity
bigchaindb/docs/contributing/source/ways-can-contribute/issue-rules.md

2.4 KiB
Raw Blame History

Issue Rules

Bad Issues Are Things Like This

We would be very sad to see you make an issue that is:

  • Your latest brain fart.
  • An idea you had to maybe do in two years.
  • "Consider this..."
  • Something nobody really cares about, not even you.
  • Showing off your knowledge and understanding of something.
  • A "feature request." Make a BEP for that. Or a small pull request with a well-defined problem and solution as desribed in C4. If you really want something, make it happen! Don't try to trick others into thinking your idea is "interesting." Get the ball rolling.
  • A proposal of any length. Write a BEP.

If you do any of the above, we will just delete your issue. We don't have time for a long cluttered list of issues.

Good Issues Are Bug Reports

There is one good issue type: a proper bug report.

  1. Go to the repository with the source code for the bug. Possibilities include:

  2. Click on the Issues tab.

  3. Click the button to create a New Issue.

  4. Describe everything in detail:

    • What computer are you on (hardware)
    • What operating system are you using, including version. e.g. Ubuntu 14.04? Fedora 23? If it's not a Linux distro, then that's probably the problem.
    • What version of BigchainDB software were you using? Did you update it to the latest?
    • What, exactly, did you do to get to the point where you got stuck? Describe all the steps so we can get there too.
    • Show screenshots or copy-and-paste text to GitHub
    • Say what you expected to happen
    • Show what actually happened
    • Say what you tried to do to resolve the problem
    • Provide details to convince us that it matters to you. Is it for a school project, a job, a contract with a deadline, a child who needs it for Christmas?

We will do our best but please understand that we don't have time to help everyone, especially people who don't care to help us help them. "It doesn't work." is not going to get any reaction from us. We need details.