Skip to content

Commit

Permalink
Create CONTRIBUTING.md (#232)
Browse files Browse the repository at this point in the history
ryonakano authored Jan 21, 2024
1 parent 6abde32 commit f133eab
Showing 2 changed files with 24 additions and 16 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/reco/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) and [its Human Interface Guidelines](https://docs.elementary.io/hig/). Try to respect them.

## Translate the Project

We accept translations through Weblate:

- [reco-app](https://hosted.weblate.org/projects/rosp/reco-app/): Texts in the app itself
- [reco-metainfo](https://hosted.weblate.org/projects/rosp/reco-metainfo/): Texts in the desktop entry and the software center
22 changes: 6 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -65,25 +65,15 @@ com.github.ryonakano.reco

## Contributing

There are many ways you can contribute, even if you don't know how to code.
Please refer to [the contribution guideline](.github/CONTRIBUTING.md) if you would like to:

### Reporting Bugs or Suggesting Improvements
- submit bug reports / feature requests
- propose coding changes
- translate the project

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

### Writing Some Code

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

### Translation

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

Click the following graphs to get started:

| App: Texts in the app itself | Metainfo: Texts in the desktop entry and the software center |
| --- | --- |
| [![Translation status](https://hosted.weblate.org/widgets/rosp/-/reco-app/multi-auto.svg)](https://hosted.weblate.org/projects/rosp/reco-app) | [![Translation status](https://hosted.weblate.org/widgets/rosp/-/reco-metainfo/multi-auto.svg)](https://hosted.weblate.org/projects/rosp/reco-metainfo) |
Need help in use of the app? Refer to [the discussions page](https://github.com/ryonakano/reco/discussions) to search for existing discussions or [start a new discussion](https://github.com/ryonakano/reco/discussions/new/choose) if none is relevant.

## The Story Behind This App

0 comments on commit f133eab

Please sign in to comment.