Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 3.99 KB

CONTRIBUTING.md

File metadata and controls

71 lines (45 loc) · 3.99 KB
Raw

Contributing to Lynx

First off, thanks for taking the time to contribute!

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Mention the project at local meetups and tell your friends/colleagues
  • Sponsor me

Table of Contents

I Have a Question

Before asking a question, please read the available Documentation first.

Before you ask a question, it is best to search for existing Issues that might help you. If you have found a suitable issue and still need clarification, please write your question in the existing issue (Even if closed).

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Use a template and provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Lynx, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • Make sure that you are using the latest version.
  • Read the documentation carefully and find out if the functionality is already covered, maybe by an individual configuration.
  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
  • Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

Code Contribution

  1. Set up your environment

    Follow the docs at https://docs.getlynx.dev/installation/installation/native.

  2. Make your changes, ensuring linters pass

  3. Commit your changes using a descriptive commit message

  4. Don't worry about updating CHANGELOG.md or VERSION. We'll sort it out later.

Improving The Documentation

The documentation uses GitBook, you may be able to edit it through their site, otherwise the repo is at https://github.com/Lynx-Shortener/docs.

Attribution

This guide is based on the contributing-gen. Make your own!