Skip to content

Commit 9edcf53

Browse files
authored
Merge pull request #169 from meinto/docs/meinto/CONTRIBUTION.md
fix(docs): indentions
2 parents e217553 + 4a291d5 commit 9edcf53

File tree

1 file changed

+24
-19
lines changed

1 file changed

+24
-19
lines changed

CONTRIBUTION.md

+24-19
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ First off, thanks for taking the time to contribute! ❤️
55
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
66

77
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
8+
>
89
> - Star the project
910
> - Tweet about it
1011
> - Refer this project in your project's readme
@@ -23,15 +24,13 @@ All types of contributions are encouraged and valued. See the [Table of Contents
2324
- [Suggesting Enhancements](#suggesting-enhancements)
2425
- [Your First Code Contribution](#your-first-code-contribution)
2526

26-
2727
## Code of Conduct
2828

2929
This project and everyone participating in it is governed by the
3030
[Spotube Code of Conduct](https://github.com/KRTirtho/spotubeblob/master/CODE_OF_CONDUCT.md).
3131
By participating, you are expected to uphold this code. Please report unacceptable behavior
3232
to <>.
3333

34-
3534
## I Have a Question
3635

3736
> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/KRTirtho/spotube#readme).
@@ -49,11 +48,11 @@ We will then take care of the issue as soon as possible.
4948
## I Want To Contribute
5049

5150
> ### Legal Notice
51+
>
5252
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
5353
5454
### Reporting Bugs
5555

56-
5756
#### Before Submitting a Bug Report
5857

5958
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
@@ -73,12 +72,11 @@ A good bug report shouldn't leave others needing to chase you up for more inform
7372

7473
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to
7574
76-
7775
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
7876

7977
- Open an [Issue](https://github.com/KRTirtho/spotube/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
8078
- Explain the behavior you would expect and the actual behavior.
81-
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
79+
- Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
8280
- Provide the information you collected in the previous section.
8381

8482
Once it's filed:
@@ -87,12 +85,12 @@ Once it's filed:
8785
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
8886
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
8987

90-
9188
### Suggesting Enhancements
9289

9390
This section guides you through submitting an enhancement suggestion for Spotube, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
9491

9592
<!-- omit in toc -->
93+
9694
#### Before Submitting an Enhancement
9795

9896
- Make sure that you are using the latest version.
@@ -101,6 +99,7 @@ This section guides you through submitting an enhancement suggestion for Spotube
10199
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset
102100

103101
<!-- omit in toc -->
102+
104103
#### How Do I Submit a Good Enhancement Suggestion?
105104

106105
Enhancement suggestions are tracked as [GitHub issues](https://github.com/KRTirtho/spotube/issues).
@@ -114,19 +113,22 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/KRTirt
114113
### Your First Code Contribution
115114

116115
<!-- Download -->
116+
117117
Do the following:
118+
118119
- Download the latest Flutter SDK (>=2.15.1) & enable desktop support
119120
- Install Development dependencies in linux
120121
- `libgstreamer1.0-dev` & `libgstreamer-plugins-base1.0-dev` (for Debian/Ubuntu)
121122
- `gstreamer`, `gst-libav`, `gst-plugins-base` & `gst-plugins-good` (for Arch/Manjaro)
122123
- Clone the Repo & Run `flutter pub get` in the Terminal
123124
- Create a `secrets.json` in root of the project. The structure should be similar to the following example:
124-
```jsoc name="secrets.json"
125-
{
125+
126+
```jsoc name="secrets.json"
127+
{
126128
"LYRICS_SECRET": [
127129
"Bo3LQEMcL2xUAJ6yCfQowV6f8K78s9J9FLa67AsyWmvhkP9LWikkgcEyFrzvs7jsR",
128-
"HiLHxLj8uv2VhBZfq9BQ9HVrWQk5Jc8aneMZX8RV4KjTmC387K692xrbNK35c8Qe4",
129-
],
130+
"HiLHxLj8uv2VhBZfq9BQ9HVrWQk5Jc8aneMZX8RV4KjTmC387K692xrbNK35c8Qe4"
131+
],
130132
"SPOTIFY_SECRET": [
131133
{
132134
"clientId": "9ed19daf-c7a2-4c28-91ac-2c5283ad86cf",
@@ -135,15 +137,18 @@ Do the following:
135137
{
136138
"clientId": "b4769027-e048-4485-8f0b-b8a336f2cd97",
137139
"clientSecret": "41df6ea4-eba2-4d42-b7be-6f727555fccc"
138-
},
139-
]
140-
}
141-
```
142-
> You can add more clientId/clientSecret/genius-access-token if you want. The credentials used in the example are dummy (fake). You've to use your own secrets
140+
}
141+
]
142+
}
143+
```
144+
145+
> You can add more clientId/clientSecret/genius-access-token if you want. The credentials used in the example are dummy (fake). You've to use your own secrets
146+
143147
- Finally run these following commands in the root of the project to start the Spotube Locally
144-
```bash
145-
$ dart bin/create-secrets.dart --local
146-
$ flutter run -d <window|macos|linux|(<android-device-id>)>
147-
```
148+
149+
```bash
150+
$ dart bin/create-secrets.dart --local
151+
$ flutter run -d <window|macos|linux|(<android-device-id>)>
152+
```
148153

149154
Do debugging/testing/build etc then submit to us with PR against the development branch (master) & we'll review your code

0 commit comments

Comments
 (0)