Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Add docs for contributing and private items #26

Merged
merged 9 commits into from
Jun 14, 2023
Prev Previous commit
Next Next commit
fix the Discord links with the new #nufmt channel
  • Loading branch information
amtoine committed Jun 13, 2023
commit 13ae3b07daa5be520982b6b3459e004e3b0167ce
5 changes: 4 additions & 1 deletion docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ 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 [`#nufmt` channel](https://discord.com/channels/601130461678272522/1087437882396004442) by joining [the discord](https://discord.gg/NtAbbGn).
Create an issue or come and say hi in the [`#nufmt` channel][nufmt discord channel] by joining [the discord][Nushell discord].
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.
Expand All @@ -18,3 +18,6 @@ This is a list of things we would like to have and mantain across time. Please d

- Everything should be explained: rust docs, comments, drawings, pick what makes you comfortable, but it is important to make it clear. There will always be some new guy or gal into the project we want to welcome 😄.
amtoine marked this conversation as resolved.
Show resolved Hide resolved
- Use clear variable names and try to avoid confusing abbreviations. Think that your peers may not be fully fluent in english 💬.

[Nushell discord]: https://discord.gg/NtAbbGn
[nufmt discord channel]: https://discord.com/channels/601130461678272522/1117921521520873623