Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

35 lines (25 loc) · 1.48 KB
Raw

Contributing

Thank you very much for taking the time for contributing to this project.

Report a Bug

Just open a new issue on GitHub and describe the bug. It helps if your description is detailed. Thank you very much for your contribution!

Suggest a New Feature

Just open a new issue on GitHub and describe the idea. Thank you very much for your contribution!

Pull Requests

I am happy for every pull request, you do not have to follow these guidelines. However, it might help you to understand the project structure and make it easier for me to merge your pull request. Thank you very much for your contribution!

1. Fork & Clone this Project

Start by clicking on the Fork button at the top of the page. Then, clone this repository to your computer.

2. Open the Project

Open the project folder in GNOME Builder, Xcode or another IDE.

3. Understand the Project Structure

  • The README.md file contains a description of the app or package.
  • The Contributors.md file contains the names or usernames of all the contributors with a link to their GitHub profile.
  • The LICENSE.md contains a GPL-3.0 license.
  • CONTRIBUTING.md is this file.
  • Directory Icons that contains the icons.
  • Sources contains the source code of the project.

4. Edit the Code

Edit the code. If you add a new type, add documentation in the code.

5. Commit to the Fork

Commit and push the fork.

6. Pull Request

Open GitHub to submit a pull request. Thank you very much for your contribution!