Skip to content

Latest commit

 

History

History
79 lines (62 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

79 lines (62 loc) · 3.24 KB

Shikai

Modern lightdm webkit2 theme

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:

  1. Make a fork of this repository.
  2. Clone the fork locally.
  3. Make the changes and additions desired to the cloned fork.
  4. Modify the CHANGELOG.md file, following its structure.
  5. Modify the package.json and CITATION.cff file, updating their version number using Semantic Versioning.
  6. Add the following header to newly added code files:
/**
 * @license Shikai
 * filename.ext
 *
 * Copyright (c) 2024, TheWisker.
 *
 * This source code is licensed under the GNU license found in the
 * LICENSE file in the root directory of this source tree.
 */
  1. Add yourself or your organization to the CONTRIBUTORS.md file, following its structure.
  2. Git add, commit, and push those changes.
  3. Open a new pull request, to merge your fork, which will be usually reviewed fast.

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 some additional steps in the /src/lang/CONTRIBUTING.md file which explain 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