Cavasik
Audio visualizer based on CAVA
Contributing
It is great to have you here. Here are a few ways you can help make this project better!
## Team Members
- Owner: [TheWisker](https://github.com/TheWisker) => TheWisker@protonmail.com
## Contributing Index
- [Adding new features][new-features-hook]
- [Adding a translation][translation-hook]
- [Other contributions][other-contributions-hook]
## Adding new features [[↑][index]]
First of all, thank you for taking the time to contribute to this project!
Here are the **steps** involved when making a contribution:
- Make a **fork** of this repository
- **Clone** the fork locally
- Make the **changes and additions** desired to the cloned fork
- **Modify** the [CHANGELOG.md][changelog] file, following its structure.
- **Modify** the [meson.build][meson] and [CITATION.cff][citation] file, updating their **version number** using [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
- Add the following **header** to newly added code files:
```
# filename.ext
#
# Copyright (c) 2023, TheWisker
# All rights reserved.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.
```
- **Add** yourself or your organization to the [CONTRIBUTORS.md][contributors] file, following its structure.
- Git **add**, **commit**, and **push** those changes.
- Open a new pull request which will be usually reviewed in less than three days.
## Adding a translation [[↑][index]]
First of all, thanks for taking the time to contribute to this project!
Usually, the process of making a translation is quite **similar** to any other contribution, so follow the steps explained [here][new-features-hook].
The main **difference** are the steps in the [/lang/CONTRIBUTING.md][lang-contributing] file which explains how to tamper with the translation files and **add** a new **translation**.
## Other contributions [[↑][index]]
You can even contribute by adding new enhancement and improvement **ideas** to the [ideas discussion][ideas-discussion] or lending someone a hand in the repository!
Author
TheWisker
[index]: https://github.com/TheWisker/Cavasik/blob/master/CONTRIBUTING.md#contributing-index
[changelog]: ./CHANGELOG.md
[meson]: ./meson.build
[citation]: ./CITATION.cff
[contributors]: ./CONTRIBUTORS.md
[new-features-hook]: https://github.com/TheWisker/Cavasik/blob/master/CONTRIBUTING.md#adding-new-features-
[translation-hook]: https://github.com/TheWisker/Cavasik/blob/master/CONTRIBUTING.md#adding-a-translation-
[other-contributions-hook]: https://github.com/TheWisker/Cavasik/blob/master/CONTRIBUTING.md#other-contributions-
[lang-contributing]: ./lang/CONTRIBUTING.md
[ideas-discussion]: https://github.com/TheWisker/Cavasik/discussions/new?category=ideas
