zellij-org/zellij
1
1
Fork 0
mirror of https://github.com/zellij-org/zellij.git synced 2024-11-29 12:28:16 +03:00
Code Issues Projects Releases Wiki Activity

wrapped lines in CONTRIBUTING.md

Browse Source
This commit is contained in:
NKGoc 2021-05-05 12:07:47 +02:00
parent 7962b44d80
commit 24b4ae831c
1 changed files with 41 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
CONTRIBUTING.md
View File

@ -2,11 +2,11 @@
Thanks for considering to contribute to Zellij! Thanks for considering to contribute to Zellij!
**First**: if you're unsure or afraid of anything, just ask on our **First**: if you're unsure or afraid of anything, just ask on our [Discord
[Discord server][discord-invite-link] or submit the issue or pull request anyway. server][discord-invite-link] or submit the issue or pull request anyway. You
You won't be yelled at for giving it your best effort. The worst that can happen won't be yelled at for giving it your best effort. The worst that can happen is
is that you'll be politely asked to change something. We appreciate any sort that you'll be politely asked to change something. We appreciate any sort of
of contributions, and don't want a wall of rules to get in the way of that. contributions, and don't want a wall of rules to get in the way of that.
# Code of Conduct # Code of Conduct
@ -14,9 +14,12 @@ Before contributing please read our [Code of Conduct](CODE_OF_CONDUCT.md) which
all contributors are expected to adhere to. all contributors are expected to adhere to.
## Building ## Building
To build Zellij, we're using cargo-make – you can install it by running `cargo install --force cargo-make`. To edit a manpage mandown crate (`cargo install mandown`) is used and the work is done on a markdown file in docs/MANPAGE.md. To build Zellij, we're using cargo-make – you can install it by running `cargo
install --force cargo-make`. To edit a manpage mandown crate (`cargo install
mandown`) is used and the work is done on a markdown file in docs/MANPAGE.md.
Zellij has a hard dependency on a package from `x11` most likely called `libX11`, or similarly on your system. Zellij has a hard dependency on a package from `x11` most likely called
`libX11`, or similarly on your system.
Here are some of the commands currently supported by the build system: Here are some of the commands currently supported by the build system:
@ -41,17 +44,18 @@ cargo make publish
cargo make manpage cargo make manpage
``` ```
To run `install` or `publish`, you'll need `binaryen --version` > 97, for it's command `wasm-opt`. To run `install` or `publish`, you'll need `binaryen --version` > 97, for it's
command `wasm-opt`.
## Looking for something to work on? ## Looking for something to work on?
If you are new contributor to `Zellij` going through [beginners][good-first-issue] If you are new contributor to `Zellij` going through
should be a good start or you can join our public [beginners][good-first-issue] should be a good start or you can join our public
[Discord server][discord-invite-link], we would be happy to help [Discord server][discord-invite-link], we would be happy to help finding
finding something interesting to work on and guide through. something interesting to work on and guide through.
[discord-invite-link]: https://discord.gg/feHDHahHCz [discord-invite-link]: https://discord.gg/feHDHahHCz [good-first-issue]:
[good-first-issue]: https://github.com/zellij-org/zellij/labels/good%20first%20issue https://github.com/zellij-org/zellij/labels/good%20first%20issue
## Filing Issues ## Filing Issues
@ -60,9 +64,11 @@ Bugs and enhancement suggestions are tracked as GitHub issues.
### Lacking API for plugin in Zellij? ### Lacking API for plugin in Zellij?
If you have a plugin idea, but Zellij still doesn't have API required to make If you have a plugin idea, but Zellij still doesn't have API required to make
the plugin consider opening [an issue][plugin-issue] and describing your requirements. the plugin consider opening [an issue][plugin-issue] and describing your
requirements.
[plugin-issue]: https://github.com/zellij-org/zellij/issues/new?assignees=&labels=plugin%20system [plugin-issue]:
https://github.com/zellij-org/zellij/issues/new?assignees=&labels=plugin%20system
### How Do I Submit A (Good) Bug Report? ### How Do I Submit A (Good) Bug Report?
@ -72,7 +78,8 @@ issue on that repository and provide the following information:
- Use a **clear and descriptive title** for the issue to identify the problem. - Use a **clear and descriptive title** for the issue to identify the problem.
- Explain which **behavior you expected** to see instead and why. - Explain which **behavior you expected** to see instead and why.
- Describe the exact **steps to reproduce the problem** in as many details as necessary. - Describe the exact **steps to reproduce the problem** in as many details as
necessary.
- When providing code samples, please use [code blocks][code-blocks]. - When providing code samples, please use [code blocks][code-blocks].
### How Do I Submit A (Good) Enhancement Suggestion? ### How Do I Submit A (Good) Enhancement Suggestion?
@ -80,23 +87,31 @@ issue on that repository and provide the following information:
Instructions are similar to those for bug reports. Please provide the following Instructions are similar to those for bug reports. Please provide the following
information: information:
- Use a **clear and descriptive title** for the issue to identify the suggestion. - Use a **clear and descriptive title** for the issue to identify the
- Provide a **description of the suggested enhancement** in as many details as necessary. suggestion.
- Provide a **description of the suggested enhancement** in as many details as
necessary.
- When providing code samples, please use [code blocks][code-blocks]. - When providing code samples, please use [code blocks][code-blocks].
[code-blocks]: https://help.github.com/articles/creating-and-highlighting-code-blocks/ [code-blocks]:
https://help.github.com/articles/creating-and-highlighting-code-blocks/
## Submitting Pull Requests ## Submitting Pull Requests
Instructions are similar to those for bug reports. Please provide the following information: Instructions are similar to those for bug reports. Please provide the following
information:
- If this is not a trivial fix, consider **creating an issue to discuss first** and **later link to it from the PR**. - If this is not a trivial fix, consider **creating an issue to discuss first**
and **later link to it from the PR**.
- Use a **clear and descriptive title** for the pull request. - Use a **clear and descriptive title** for the pull request.
- Follow [Conventional Commit specification](https://www.conventionalcommits.org/en/v1.0.0/) - Follow [Conventional Commit
where sufficiently large or impactful change is made. specification](https://www.conventionalcommits.org/en/v1.0.0/) where
sufficiently large or impactful change is made.
- Provide a **description of the changes** in as many details as necessary. - Provide a **description of the changes** in as many details as necessary.
Before submitting your pull request, also make sure that the following conditions are met: Before submitting your pull request, also make sure that the following
conditions are met:
- Your new code **adheres to the code style** through running `cargo fmt`. - Your new code **adheres to the code style** through running `cargo fmt`.
- Your new code **passes all existing and new tests** through running `cargo test`. - Your new code **passes all existing and new tests** through running `cargo
test`.