Skip to content

Latest commit

 

History

History
76 lines (59 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

76 lines (59 loc) · 3.17 KB
Raw

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

Contributing Index

Adding new features [↑]

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 file, following its structure.
  • Modify the meson.build and CITATION.cff file, updating their version number using Semantic Versioning
  • 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 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 [↑]

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. The main difference are the steps in the /lang/CONTRIBUTING.md file which explains how to tamper with the translation files and add a new translation.

Other contributions [↑]

You can even contribute by adding new enhancement and improvement ideas to the ideas discussion or lending someone a hand in the repository!

Author

TheWisker