-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 Add docs for contributing and private items
- Loading branch information
Showing
6 changed files
with
99 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
https://discord.gg/NtAbbGn# Contributing to `nufmt` | ||
|
||
Salutations! Thanks for coming by and the interest into this project! | ||
We would like to order the contributions like this: | ||
|
||
- Before you start hacking, it is important to **ask first** if your idea or bugfix is in order. Create an issue or [come and say hi in the discord](https://discord.gg/NtAbbGn). We don't bite!. | ||
|
||
It would be sad that you do the effort to clone the project, successfully make the PR, but it wasn't in our plans or there is another PR that is currently adressing that issue. | ||
|
||
- After the PR is submitted, the workflows will start to lint, check and test the changes. Please try to stay all green ✅. | ||
- Sometimes we can take some time to respond. Sorry, we are few and there is much to do here! | ||
|
||
## General guidelines and philosophy | ||
|
||
This is a list of things we would like to have and mantain across time. Please do your best to abide by. | ||
|
||
- Everything should be explained: rust docs, comments, drawings, pick what makes you comfortable, but it is important to make it clear. There will be always some new guy or gal into the project we want to welcome 😄. | ||
- Use clear variable names and try to evade confusing abbreviations. Think that your peer may not be fully fluent in english 💬. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters