mirror of
https://github.com/vacp2p/nim-libp2p.git
synced 2026-08-27 10:21:08 +00:00
37 lines
2.6 KiB
Markdown
37 lines
2.6 KiB
Markdown
# Contribution to nim-libp2p
|
||
|
||
You are welcome to work on any change you’d like to see in `nim-libp2p`.
|
||
|
||
## Choosing issue
|
||
|
||
Feel free to browse the existing issues in the repository, especially those marked as [good first issue](https://github.com/vacp2p/nim-libp2p/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22good%20first%20issue%22), which are particularly suitable for newcomers looking to contribute. These issues are designed to be easy and straightforward.
|
||
|
||
When choosing an existing issue to work on, please ping the core maintainers so they can assign it to you. This will prevent working on the same issue and core maintainers may give you some hints.
|
||
|
||
## Perform code reviews
|
||
|
||
Feel free to let us know if you found anything that can a) speed up the project development b) ensure better quality and c) reduce possible future bugs.
|
||
|
||
## Contribute
|
||
|
||
- **Developing**. Read the [development](https://github.com/vacp2p/nim-libp2p/blob/master/docs/development.md) guide to get started with the project and testing the code. Additionally, check the [compile time flags](https://github.com/vacp2p/nim-libp2p/blob/master/docs/compile_time_flags.md) page, where all available compile-time flags are documented. Reading [common hurdles](https://github.com/vacp2p/nim-libp2p/blob/master/docs/common_hurdles.md) for frequently encountered issues can be helpful to prevent painful time loss in advance.
|
||
- **Small PRs**. Try to keep PRs atomic and digestible. This makes the review process and pinpointing bugs easier.
|
||
- **Are you stuck or need help?**. Direct questions to core maintainers via issues, they will be fast to respond. Or connect with core contributors in our [community channel](https://discord.com/channels/1204447718093750272/1351621032263417946).
|
||
- **Open a PR**. Open a PR whenever you feel ready. Assign the core maintainers for review, and they’ll be right there to help you through the process.
|
||
|
||
## Core Maintainers
|
||
|
||
<table>
|
||
<tbody>
|
||
<tr>
|
||
<td align="center"><a href="https://github.com/richard-ramos"><img src="https://avatars.githubusercontent.com/u/1106587?v=4?s=100" width="100px;" alt="Richard"/><br /><sub><b>Richard</b></sub></a></td>
|
||
<td align="center"><a href="https://github.com/vladopajic"><img src="https://avatars.githubusercontent.com/u/4353513?v=4?s=100" width="100px;" alt="Vlado"/><br /><sub><b>Vlado</b></sub></a></td>
|
||
<td align="center"><a href="https://github.com/gmelodie"><img src="https://avatars.githubusercontent.com/u/8129788?v=4?s=100" width="100px;" alt="Gabe"/><br /><sub><b>Gabe</b></sub></a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
---
|
||
|
||
[← Back to README](../README.md)
|