Skip to content

Commit

Permalink
Merge pull request #7 from Wilovy09/develop
Browse files Browse the repository at this point in the history
add CONTRIBUTING.md file
  • Loading branch information
Wilovy09 authored Jun 18, 2024
2 parents 31bf397 + 9664186 commit 7109979
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# How to contribute to the project

> [!NOTE]
> Your PR has to go to the `develop` branch.
## Add support to an LSP

> [!TIP]
> You can take inspiration from an existing LSP in the project.
- You have to create a folder with the name of the language that is supported by the LSP.
- Inside this folder you will put a `mod.rs` file with your functions.
- Then add the folder to `langauages/mod.rs` so you can use it in `src/main.rs`.
- When adding it to the user configuration, use the existing function in the `utilities/conbfig_managment.rs` file.
- Make the necessary changes to the `src/main.rs` so that when using the command it will work.
- Run `cargo fmt --all`.
- Run `cargo clippy -- -D warnigs` and fix the warnings/errors that clippy throws.

## Improve the code

- Just make the changes and in your PR explain why it is better.
- Run `cargo fmt --all`.
- Run `cargo clippy -- -D warnigs` and fix the warnings/errors that clippy throws.

## Take into account

If we make both changes, improve code and add support for an LSP.

Please do it in separate PRs explaining what you did.

0 comments on commit 7109979

Please sign in to comment.