Skip to content

Latest commit

 

History

History
241 lines (163 loc) · 5.05 KB

CONTRIBUTING.md

File metadata and controls

241 lines (163 loc) · 5.05 KB

Welcome to Lite XL website contributing guide

We're grateful for your contribution. Your contribution will be reflected on https://lite-xl.com.

This guide goes over several important notes you need to take account when contributing to the website.

Issues

Creating an issue

You should search the issue tracker for a similar issue before creating one. When creating an issue, ensure that it has an appropriate title, description and an example to recreate the issue.

Solving an issue

We do not assign issues to anyone. You're welcome to submit PRs for an existing issue.

Contributing code changes

We accept PRs for website content. If you want to contribute, make sure that you've read the site rules.

Localization

Localizations are welcomed, but we have limited capacity to proofread the content. As such, the canonical source of information will be the English version.

Site Rules

You must follow these rules when contributing to the website. Do note that this is not a complete list; we may advise on further improvements as we review your PRs.

Don't

Submit content that is badly-written or irrelevant to Lite XL.

Do

Submit content that is well-written and relevant to Lite XL.

Proofread your work before submitting.

Don't

Omit title / heading when creating new content. Use confusing / misleading titles and descriptions.

Do

Create a relevant title / heading when creating new content. Always specify a description in the front matter in the form of "Learn X in Lite XL".

Don't

Use irregular indentation on the website code.

function updatePage() {
   if (this.length === 0)
      this.push(1);
   this.forEach(function(e) { return e + 1; });
}

Do

Follow the EditorConfig (2 space as indentation).

function updatePage() {
  if (this.length === 0)
    this.push(1);
  this.forEach(function(e) { return e + 1; });
}

Don't

Write incredibly long lines that cannot be broken down.

I love Lite XL because the editor provides many features out of the box such as syntax highlighting, filesystem tree and lua scripting which I use extensively to customize the editor to such an extent where it is so much better than the original jeez >//< i love lite-xl so muchhhhh!!!!

Do

Adhere to a 90 character soft-limit and a 110-character hard limit. For long lines, break them down appropriately, e.g. adding line breaks after punctuations and stop words. Start sentences on new lines when appropriate.

For long list items, break them down into multiple lines and indent the following lines with 2 spaces.

I love Lite XL because the editor provides many features:

- syntax highlighting
- filesystem tree
- lua scripting
- a killer feature that we probably don't have yet but we'll
  have in the future

I use the lua scripting feature extensively to customize the editor
so that it is better than the original jeez >//<
i love lite-xl so muchhhhh!!!!

Don't

Omit newlines between markdown elements.

# Installation
You can install Lite XL by running:
```sh
# sudo apt install lite-xl
```
or the following ways:
- download a release
- install it via lpm

Do

Introduce a newline between Markdown elements. This helps with certain picky Markdown parsers.

# Installation

You can install Lite XL by running:

```sh
# sudo apt install lite-xl
```

or the following ways:

- download a release
- install it via lpm

Don't

Use < and > without surrounding them in backticks.

Watch me! <script>alert("hey");</script>

Do

Use ‹ and › or surround < and > in backticks.

Watch me! `<script>alert("hey");</script>`

Don't

Link to insecure websites.

[1]: http://example.com

Do

Link to secure websites.

[1]: https://example.com

Don't

Use inline links except for auto-links or anchors.

Follow [this link](https://someurl.com) and also [this interesting one](https://interesting-one.com).

[We allow this](#this-will-be-allowed)

# this will be allowed

We allow this form of inline linking because it is short and useful.

Do

Use reference-style links.

Follow [this link] and also [this interesting one].

<!-- at the bottom of the page after 2 blank lines, vertically aligned: -->
[this link]:            https://someurl.com
[this interesting one]: https://interesting-one.com

Or

Follow [this link][1] and also [this interesting one][2].

<!-- at the bottom of the page after 2 blank lines, vertically aligned: -->
[1]: https://someurl.com
[2]: https://interesting-one.com

Don't

Create messy Markdown tables (unless machine generated).

| name | Description
|---:|---|
| John | Doe
| Jeanne | Doe

Do

  • Align the pipe character (|) to the left.
  • Ensure dashes (excluding the alignment colon character(:)) aligns with the table header.
  • Add indentation so text is aligned with the column's alignment. If the column aligns to the right, the text inside should too.
|   name | Description
|   ----:| -----------
|   John | Doe
| Jeanne | Doe