mirror of
https://github.com/bigchaindb/bigchaindb.git
synced 2024-10-13 13:34:05 +00:00
Cleanup 'Ways to Contribute' even more
This commit is contained in:
parent
d4e8f415a1
commit
f54090af6d
@ -1,10 +1,12 @@
|
||||
Ways to Contribute
|
||||
==================
|
||||
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
bug-report
|
||||
issue-rules
|
||||
write-a-bep
|
||||
write-code
|
||||
vanshdeep-notes
|
||||
|
@ -1,4 +1,23 @@
|
||||
# Write a Bug Report
|
||||
# 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](write-a-bep.html) 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:
|
||||
|
||||
@ -23,4 +42,3 @@
|
||||
- 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_.
|
||||
|
@ -1,9 +1,18 @@
|
||||
# Write a BigchaindB Enhancement Proposal (BEP)
|
||||
|
||||
This is what you do if you want to request a new feature or a change in how BigchainDB works. The more clearly you write,
|
||||
the better chance you have of convincing us that it's easy and worth doing.
|
||||
This is the main way to get new BigchainDB code into the project.
|
||||
|
||||
There are two general paths:
|
||||
|
||||
1. Create a BEP. Then create a pull request to implement it. And so on.
|
||||
1. Create a new pull request straight away. This is less likely to work. It is only going to be permitted if the problem being solved is clear, obvious, small and well-defined in the pull request. If it's not, then a BEP was needed and you need to go back and write a BEP first.
|
||||
|
||||
|
||||
## Tips
|
||||
|
||||
- Review [1/C4](https://github.com/bigchaindb/BEPs/tree/master/1), the process we use to accept any new code or PR of any kind, including one that adds a BEP to `bigchaindb/BEPs`.
|
||||
- Review [2/COSS](https://github.com/bigchaindb/BEPs/tree/master/2). Maybe print it for reference. It outlines what can go in a BEP.
|
||||
- Don't spend weeks on your BEP. Version 1 should take a few hours to write up, maximum. You can add to it in the future. The process is iterative. If you need more than a few hours, then consider writing multiple BEPs.
|
||||
- Do not start writing code before you think about it. You should always write a BEP first. Once you do that, you _can_ start implementing it. To do that, make a pull request and say it implements your BEP.
|
||||
- If you're thinking of writing a new _issue_, think again. See the page [Issue Rules](issue-rules.html).
|
||||
|
||||
1. Review [2/COSS](https://github.com/bigchaindb/BEPs/tree/master/2). Maybe print it for reference.
|
||||
1. Folowing those guidelines, make a pull request against the [bigchaindb/BEPs](https://github.com/bigchaindb/BEPs) repository on GitHub.
|
||||
1. Don't spend weeks on this. Version 1 should take a few hours to write up, maximum. You can add to it in the future. The process is iterative.
|
||||
If you need more than a few hours, then consider writing multiple BEPs.
|
||||
|
@ -4,12 +4,9 @@ Write Code
|
||||
What are you Doing???
|
||||
---------------------
|
||||
|
||||
If you want to resolve an issue, then find one that is open and unresolved.
|
||||
|
||||
If you want to implement a BEP, then pick one you believe you can implement. You can ask for help, but not to do *everything*.
|
||||
All BEPs are in the `bigchaindb/BEPs <https://github.com/bigchaindb/BEPs>`_ repository on GitHub.
|
||||
|
||||
Tell us what you're doing so we don't do it too. You can tell us on Gitter or by email.
|
||||
Tell us what you're doing somewhere so we don't do it too. You can tell us on Gitter or by email.
|
||||
If you're not sure how to proceed, see the :ref:`Issue Rules` and :ref:`Write a BEP <Write a BigchaindB Enhancement Proposal (BEP)>`
|
||||
for inspiration.
|
||||
|
||||
|
||||
Refresh Yourself about the C4 Process
|
||||
@ -136,11 +133,7 @@ If we want to make changes, we'll do them in a follow-up PR.
|
||||
|
||||
-----------------
|
||||
|
||||
You are awesome. We will send swag if you let us. Do you want a job? Apply! Berlin is great. Meet the pandas. Say hi to Angela Merkel. Walk along the Unter den Linden. See where Einstein and Planck taught university. Contemplate the speed of light on the actual Potsdamer Platz platform.
|
||||
|
||||
See the former location of the telescope that first revealed the planet Neptune to human eyes. (The telescope is now in Munich.) Fresh spargel in the spring! Fresh kurbis in the fall! Rain all winter. The weather is perfect. You will love it.
|
||||
|
||||
`Unsplash photos of Berlin <https://unsplash.com/search/photos/berlin>`_
|
||||
You are awesome. Do you want a job? `Apply! <https://github.com/bigchaindb/org/tree/master/jobs>`_ Berlin is great. If you got this far, we'd be happy to consider you joining our team. Look at these `Unsplash photos of Berlin <https://unsplash.com/search/photos/berlin>`_. So nice.
|
||||
|
||||
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user