X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=CONTRIBUTING.md;h=e795ecb9fba7b3c48a5f7732ce96719b28d32c16;hb=89524466843e60676a117b77e1e0b41cd4230d7d;hp=f7cf8c4e699e3578285abbdbe3c72b8a0f06759b;hpb=28c9b56113ff1ebb1b505a2c979c55c1626aa06b;p=rust-lightning diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f7cf8c4e..e795ecb9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,13 +12,15 @@ testing and risk-minimization. Any bug may cost users real money. That being said, we deeply welcome people contributing for the first time to an open source project or pick up Rust while contributing. Don't be shy, you'll learn. +For the project Code of Conduct, see our [website](https://lightningdevkit.org/code_of_conduct). + Communication Channels ----------------------- Communication about the development of LDK and `rust-lightning` happens primarily on the [LDK Discord](https://discord.gg/5AcknnMfBw) in the `#ldk-dev` -channel. Additionally, live LDK devevelopment meetings are held every other -Monday 19:00 UTC in the [LDK Dev Jitsi Meeting +channel. Additionally, live LDK development meetings are held every other +Monday 17:00 UTC in the [LDK Dev Jitsi Meeting Room](https://meet.jit.si/ldkdevmeeting). Upcoming events can be found in the [LDK calendar](https://calendar.google.com/calendar/embed?src=c_e6fv6vlshbpoob2mmbvblkkoj4%40group.calendar.google.com). @@ -41,7 +43,7 @@ This doesn't mean don't be ambitious with the breadth and depth of your contributions but rather understand the project culture before investing an asymmetric number of hours on development compared to your merged work. -Browsing through the [meeting minutes](https://github.com/lightningdevkit/rust-lightning/wiki/Meetings) +Browsing through the [meeting minutes](https://github.com/lightningdevkit/rust-lightning/wiki/Meeting-Notes) is a good first step. You will learn who is working on what, how releases are drafted, what are the pending tasks to deliver, where you can contribute review bandwidth, etc. @@ -100,6 +102,10 @@ comment suggesting that you're working on it. If someone is already assigned, don't hesitate to ask if the assigned party or previous commenters are still working on it if it has been awhile. +Any changes that have nontrivial backwards compatibility considerations should +have an entry added in the `pending_changelog` folder which includes the +CHANGELOG entries that should be added in the next release. + Peer review -----------