Skip to content

Commit

Permalink
Create CONTRIBUTING.md (#117)
Browse files Browse the repository at this point in the history
  • Loading branch information
ryonakano authored Jan 25, 2024
1 parent 827e8f8 commit a1a84fc
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 6 deletions.
18 changes: 18 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Contributing

There are many ways you can contribute, even if you don't know how to code.

## Submit Bug Reports / Feature Requests

Simply [create a new issue](https://github.com/ryonakano/pinit/issues/new) describing your problem and how to reproduce or your suggestion. If you are not used to do, [this section](https://docs.elementary.io/contributor-guide/feedback/reporting-issues) is for you.

## Propose Coding Changes

We follow [the coding style of elementary OS](https://docs.elementary.io/develop/writing-apps/code-style). Try to respect them.

## Translate the Project

We accept translations through Weblate:

- [pinit-app](https://hosted.weblate.org/projects/rosp/pinit-app/): Texts in the app itself
- [pinit-metainfo](https://hosted.weblate.org/projects/rosp/pinit-metainfo/): Texts in the desktop entry and the software center
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,14 @@ ninja install -C builddir
com.github.ryonakano.pinit
```

## Help Translation of This Project!
We accept translations of this project through [Weblate](https://weblate.org/). We would appreciate it if you would join our translation work!
## Contributing

Click the following graphs to get started:
Please refer to [the contribution guideline](.github/CONTRIBUTING.md) if you would like to:

| App: Texts in the app itself | Metainfo: Texts in the desktop entry and the software center |
| --- | --- |
| [![Translation status](https://hosted.weblate.org/widgets/rosp/-/pinit-app/multi-auto.svg)](https://hosted.weblate.org/projects/rosp/pinit-app) | [![Translation status](https://hosted.weblate.org/widgets/rosp/-/pinit-metainfo/multi-auto.svg)](https://hosted.weblate.org/projects/rosp/pinit-metainfo) |
- submit bug reports / feature requests
- propose coding changes
- translate the project

## Get Support

Need help in use of the app? Refer to [the discussions page](https://github.com/ryonakano/pinit/discussions) to search for existing discussions or [start a new discussion](https://github.com/ryonakano/pinit/discussions/new/choose) if none is relevant.

0 comments on commit a1a84fc

Please sign in to comment.