awesome-linux-ricing/CONTRIBUTING.md

# Contributing

Thank you for taking interest in helping fill this list! Every helpful contribution is really appreciated.

Here is a little guide to help with the process of contributing.

---

## Table of Contents

1. [Code of Conduct](#code-of-conduct)
2. [How to Contribute](#how-to-contribute)
3. [Submitting a Pull Request](#submitting-a-pull-request)
4. [What to add](#what-to-add)
5. [License](#license)

---

### Code of Conduct

Some very generic stuff. Please be respectful and constructive in all interactions. See the [Code of Conduct](CODE_OF_CONDUCT.md) for more details.

### How to Contribute

There are several ways to help this project:

1. **Submit an issue**: If you are not comfortable sending a pull request, you can always just open a new [issue](https://github.com/avtzis/awesome-linux-ricing/issues).
2. **Suggest a new item**: Any new item that you think should be included in the list is welcome. Just submit a pull request and will merge.
3. **Modify something from the list**: Fix a typo, improve descriptions, add more information, remove unnecessary info, etc.

### Submitting a Pull Request

A simple guide for pull requests:

1. **Fork the repository** and clone your fork to your local machine.
    ```bash
    git clone https://github.com/avtzis/awesome-linux-ricing.git
    ```
2. **Create a new branch** for your feature or fix.
    ```bash
    git checkout -b "add-item"
    ```
3. **Make your changes** and **commit** them with clear, descriptive messages.
    ```bash
    git commit -am "Add item"
    ```
4. **Push to your fork** on GitHub.
    ```bash
    git push origin add-item
    ```
5. **Open a pull request** on the main repository, and add a description of your changes.

### What to add

Any item related to ricing, that:
  - Works on Linux
  - Is **AWESOME** and sexy
  - Is helpful and useful
  - You made and want to share
  - You saw on [r/unixporn](https://www.reddit.com/r/unixporn/)

is very much welcome.

List items should be formmated like this:
```markdown
- [Item Name](link) - Description.
```

You can use the original repo's description. To specify display protocol (X11, Wayland, etc.), or something else, use superscript:
```markdown
- [Item Name](link)<sup>display-protocol</sup> - Description.
```

Preview:
- [Item Name](link)<sup>display-protocol</sup> - Description.

### License

By contributing to this repository, you agree that your contributions will be licensed under the same license as the project (see the [LICENSE](LICENSE) file for details).

---

Thank you again!