Skip to content

Commit

Permalink
Fix template files
Browse files Browse the repository at this point in the history
 - Fix PULL_REQUEST_TEMPLATE.md

 - Fix CONTRIBUTING.md
  • Loading branch information
tesshucom authored and brand-change committed Dec 10, 2020
1 parent e1fd171 commit 2cd798b
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 14 deletions.
35 changes: 27 additions & 8 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,32 @@
# Guidelines for Contributing
# Contributing to Jpsonic

Jpsonic development is a community project, and contributions are welcomed. Here are a few guidelines you should follow before submitting:
Jpsonic is released under the GPLv3.
All contributions must be licensed as [GNU GPLv3](https://github.com/airsonic/airsonic/blob/develop/LICENSE.txt) to be accepted. Use [`git commit --signoff`](https://jk.gs/git-commit.html) to acknowledge this.
If you would like to contribute something, or want to hack on the code this document should help you get started.

1. **License Acceptance** All contributions must be licensed as [GNU GPLv3](https://github.com/airsonic/airsonic/blob/develop/LICENSE.txt) to be accepted. Use [`git commit --signoff`](https://jk.gs/git-commit.html) to acknowledge this.
2. **No Breakage** New features or changes to existing ones must not degrade the user experience. This means do not introduce bugs, remove functionality, or make large changes to existing themes/UI without prior discussion in an Issue.
It is because it hinders Airsonic's follow-up. For the addition of the UI, consider the viewpoint "necessary for Japanese-ready function" and "avoid competition with Airsonic".
3. **Coding standards** Language best-practices should be followed, comment generously, and avoid "clever" algorithms. It does not do simple refactoring. It is because it hinders Airsonic's follow-up.
4. **I will fix it!** I love you. Plese try [submiting a patch](https://github.com/tesshucom/jpsonic/issues?q=is%3Aissue+is%3Aopen+label%3Apatches-welcome) for an open Issue.
5. **Good thought that!** If you would like to have ideas and suggestions on Japanese processing at ease, fill in the comments on the author's site. Let's go easy. I love you. I said twice.
## Code of Conduct

This project adheres to the [Citizen Code of Conduct](https://github.com/tesshucom/jpsonic/blob/fix-contributing.md/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.

## Using GitHub Issues

We use GitHub issues to track bugs and probrems.

### Bug report

Be careful when reporting bugs.
- Double bug report posts will be discarded. Topics that are common to sibling servers other than Jpsonic, not just Jpsonic, are considered double posts.
- Please help to speed up problem diagnosis by providing as much information as possible. Follow the template.

### Questions

If you have questions about traditional and basic usage please ask on Airsonic community.
Questions about Jpsonic's original features are accepted, but it's probably faster to ask on the [author's site](https://tesshu.com/jpsonic/faq).

### Feature request

Currently we are not accepting requests.
I don't know the future policy yet.

## Working with the Code

Expand Down
30 changes: 24 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@

<details>
<summary>Suggesting modifications Definition in Airsonic</summary>

<blockquote>

# Suggesting modifications

Airsonic's source code is hosted on [github](https://github.com/airsonic/airsonic/),
Expand All @@ -10,6 +15,14 @@ a relatively small group of contributors who have many other responsibilities
and demands on their time. Development, maintenance, and administration of the
project is done on a best-effort basis, as time and other constraints permit.

</blockquote>

</details>

<details>
<summary>Getting your pull-requests reviewed and merged in Airsonic</summary>

<blockquote>

# Getting your pull-requests reviewed and merged

Expand Down Expand Up @@ -70,10 +83,15 @@ quickly if needed. Even after acceptance, the inclusion of larger changes may
be delayed until a major version release in order to ensure that the impact to
users is minimized and that stability is maintained.

# Getting help
</blockquote>

</details>

By the way,

- Jpsonic does not accept pull requests at this time.
- This is entirely a matter of my capacity. Accepting indiscriminate requests is because we have determined that the side effects outweigh the slight benefits.
- This is the current status and can change if circumstances change
- If you have a request that involves a big architect change rather than a small feature, and it's a very groundbreaking idea that benefits a lot of people, and most of the design/implementation/verification work is done by you alone, then please contact us.

The documentation is hosted [here](https://airsonic.github.io/) (you can
contribute to it [here](https://github.com/airsonic/documentation)), and aims
at being comprehensive. You can also use [irc](irc://irc.freenode.net/airsonic)
and [reddit](https://www.reddit.com/r/airsonic/) if you want to discuss or ask
questions.

0 comments on commit 2cd798b

Please sign in to comment.