Rooba
/
lapce
mirror of https://github.com/lapce/lapce.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
lapce/CONTRIBUTING.md

2.7 KiB
Raw Blame History

How to contribute

Thank you for your interest in contributing to Lapce! No contribution is too small and we consider all contributions to the project. There are many ways to contribute (a few are listed here) but if you think of something else, join us on Discord or let us know via an issue.

A summary of how to contribute is below. If you are a user, also check out this guide. If you are a developer, also check out this guide.

Feature Requests

A feature request is something you want to have included in Lapce. We track feature requests on GitHub via issues. There are generally two kinds of features:

  1. A feature more suited to the core development of Lapce. If this is the case please make a suggestion in an issue.
  2. A feature that is more suited to a Plugin. We currently have an issue to track requests specifically for Plugins! You can view the discussion and make suggestions here.

To reduce the number of duplicate requests, please search through the issues to see if something has already been suggested. If a feature you want has been suggested, then comment on that issue to let us know it's popular. You can use emoji-reactions to show us just how popular!

Bug Reports

Bugs should also be reported on GitHub via issues. This allows us to track them and see how prevalent they are.

If you encounter a bug when using Lapce, check the issues to see if anyone else has encountered it. If it already exists, you can use emoji reactions to indicate it should be fixed ASAP!

Pull Requests

If you want to write some code, develop the documentation, or otherwise work on a certain feature or bug, let us know by replying to or creating an issue.

Run cargo fmt --all and cargo clippy on your code before submitting pull requests and fix any issues; this makes sure that the CI runs only fail on genuine build errors and not formatting/Clippy lints.

We are currently in the process of improving the documentation for new developers/code contributors. Feel free to get started, or post a message on Discord to see what can be done.

Contact

As always, if you have any questions or are just not sure where to start, post a message into the Discord server. We suggest you start here as it is the most popular way for Lapce's contributors and users to communicate.