Add Contributing
34
Contributing.md
Normal file
34
Contributing.md
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
# Contributing to Conflux
|
||||||
|
|
||||||
|
Thank you for your interest!
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
|
||||||
|
1. Fork the repository
|
||||||
|
2. Clone your fork
|
||||||
|
3. Create a feature branch
|
||||||
|
4. Submit a pull request
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
- JDK 21+
|
||||||
|
- Standard Gradle build
|
||||||
|
|
||||||
|
## Tests
|
||||||
|
|
||||||
|
JUnit tests are included, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
gradle test
|
||||||
|
```
|
||||||
|
|
||||||
|
## Code Style
|
||||||
|
|
||||||
|
* 4-space indentation
|
||||||
|
* Clean JavaDoc
|
||||||
|
* Tests should print method names and "...ok" at the end
|
||||||
|
* Prefer clear, minimal code
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
[[Home]] | [[Changelog]]
|
||||||
Reference in New Issue
Block a user