Ver Fonte

[book] Add more info for beginners in Contributing

Added a summary of a recent discussion from the dev meeting, including:
- how to approach learning
- how to find specific tasks
- specialization is a good thing
y há 3 anos atrás
pai
commit
6bdcadb958
1 ficheiros alterados com 29 adições e 3 exclusões
  1. 29 3
      doc/src/development/contributing.md

+ 29 - 3
doc/src/development/contributing.md

@@ -1,13 +1,39 @@
-# Areas of work
+# Contributing
+
+## How to get started
 
 Every monday 16:00 CET, there is our main dev meeting on
 [our chat](https://darkrenaissance.github.io/darkfi/misc/ircd/ircd.html).
 Feel free to join and discuss with other darkfi devs.
 
+In general, the best way to get started is to explore the codebase thoroughly and
+identify issues and areas of improvement.
+
+Contribute according to your own interests, skills, and topics in which you would
+like to become more knowledgable. Take initiative. Other darkfi devs can help you
+as mentors: see [the Methodology section of the Study Guide](https://darkrenaissance.github.io/darkfi/development/learn.html#methodology).
+
+Few people are able be an expert in all domains. Choose a topic and specialize.
+Example specializations are described [here](https://darkrenaissance.github.io/darkfi/development/learn.html#branches).
+Don't make the mistake that you must become an expert in all areas before getting started.
+It's best to just jump in.
+
+## Finding specific tasks
+
+Tasks are usually noted in-line using code comments. All of these tasks should be resolved
+and can be considered a priority.
+
+To find them, run the following command:
+```
+git grep -E 'TODO|FIXME'
+```
+
+## Areas of work
+
 There are several areas of work that are either undergoing maintenance 
 or need to be maintained:
 
-* **Documentation:** general documentation and code docs (cargo doc). this is a very 
+* **Documentation:** general documentation and code docs (cargo doc). This is a very 
   important work for example [overview](https://darkrenaissance.github.io/darkfi/architecture/overview.html) 
   page is out of date.
 * **Tooling:** Such as the `drk` tool. right now 
@@ -24,6 +50,6 @@ or need to be maintained:
   files and try them out without having to write rust code. It will tell 
   you the time to create and verify the proof, as well as the byte size of 
   the proof.
-  * We should also have Python bindings for working with Scalars, EC points, merkle trees and hashing.
+  * We should also have **Python bindings** for working with Scalars, EC points, merkle trees and hashing.
 * **Events System:** We need to fix IRCD, we will need to implement the 
   [events](https://darkrenaissance.github.io/darkfi/misc/event_graph/event_graph.html) system.