Skip to content

Commit 14123fe

Browse files
committed
docs: More info for contributors
1 parent b3a02bd commit 14123fe

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
open_collective: "codetracer"

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ An unfinished prototype of a recorder of Python programs that produces [CodeTrac
66
> Currently it is in a very early phase: we're welcoming contribution and discussion!
77
88

9-
### usage
9+
### Usage
1010

1111
you can currently use it directly with
1212

@@ -18,7 +18,7 @@ python trace.py <path to python file>
1818

1919
however you probably want to use it in combination with CodeTracer, which would be released soon.
2020

21-
## future directions
21+
## Future directions
2222

2323
The current Python support is an unfinished prototype. We can finish it. In the future, it may be expanded to function in a way to similar to the more complete implementations, e.g. [Noir](https://github.com/blocksense-network/noir/tree/blocksense/tooling/tracer).
2424

@@ -49,14 +49,14 @@ It would be useful to have a way to record in detail only certain periods of the
4949
we plan on expanding the [trace format](https://github.com/metacraft-labs/runtime_tracing/) and CodeTracer' support, so that this is possible. It would let one be able to record interesting
5050
parts of even long-running or more heavy programs.
5151

52-
### Cooperation
52+
### Contributing
5353

54-
We'd be very happy if the community finds this useful, and if anyone wants to
54+
We'd be very happy if the community finds this useful, and if anyone wants to:
5555

56-
* Cooperate with us on supporting/advancing the Python support or CodeTracer
57-
* Contribute Python support or anything else to this trace or to [CodeTracer](https://github.com/metacraft-labs/CodeTracer)
58-
* Just discuss various ideas with us: here, in the issue tracker, or in our [discord](https://discord.gg/qSDCAFMP)
59-
* Use and test the ruby support or CodeTracer
56+
* Use and test the Python support or CodeTracer.
57+
* Provide feedback and discuss alternative implementation ideas: in the issue tracker, or in our [discord](https://discord.gg/qSDCAFMP).
58+
* Contribute code to enhance the Python support of CodeTracer.
59+
* Provide [sponsorship](https://opencollective.com/codetracer), so we can hire dedicated full-time maintainers for this project.
6060

6161
### Legal info
6262

0 commit comments

Comments
 (0)