Skip to content

Commit 45c3287

Browse files
committed
update markdown files
Signed-off-by: Adam Ratzman <[email protected]>
1 parent 50915fd commit 45c3287

File tree

3 files changed

+21
-150
lines changed

3 files changed

+21
-150
lines changed

CODE_OF_CONDUCT.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 5 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,10 @@
11
# Contributing
22

3-
When contributing to this repository, please first discuss the change you wish to make via issue,
4-
email, or any other method with the owners of this repository before making a change.
5-
6-
Please note we have a code of conduct, please follow it in all your interactions with the project.
3+
When contributing to this repository, feel free to first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
75

6+
However, any library additions are always welcome. I am especially looking for the addition of new Kotlin/Native
7+
targets.
88

99
## Testing
10-
Please see [testing.md](TESTING.md) for full testing instructions. Your contributions should be able to pass every test
11-
12-
## Pull Request Process
13-
14-
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
15-
build.
16-
2. Update the README.md with details of changes to the interface, this includes new environment
17-
variables, exposed ports, useful file locations and container parameters.
18-
3. Increase the version numbers in any examples files and the README.md to the new version that this
19-
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
20-
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
21-
do not have permission to do that, you may request the second reviewer to merge it for you.
22-
23-
## Code of Conduct
24-
25-
### Our Pledge
26-
27-
In the interest of fostering an open and welcoming environment, we as
28-
contributors and maintainers pledge to making participation in our project and
29-
our community a harassment-free experience for everyone, regardless of age, body
30-
size, disability, ethnicity, gender identity and expression, level of experience,
31-
nationality, personal appearance, race, religion, or sexual identity and
32-
orientation.
33-
34-
### Our Standards
35-
36-
Examples of behavior that contributes to creating a positive environment
37-
include:
38-
39-
* Using welcoming and inclusive language
40-
* Being respectful of differing viewpoints and experiences
41-
* Gracefully accepting constructive criticism
42-
* Focusing on what is best for the community
43-
* Showing empathy towards other community members
44-
45-
Examples of unacceptable behavior by participants include:
46-
47-
* The use of sexualized language or imagery and unwelcome sexual attention or
48-
advances
49-
* Trolling, insulting/derogatory comments, and personal or political attacks
50-
* Public or private harassment
51-
* Publishing others' private information, such as a physical or electronic
52-
address, without explicit permission
53-
* Other conduct which could reasonably be considered inappropriate in a
54-
professional setting
55-
56-
### Our Responsibilities
57-
58-
Project maintainers are responsible for clarifying the standards of acceptable
59-
behavior and are expected to take appropriate and fair corrective action in
60-
response to any instances of unacceptable behavior.
61-
62-
Project maintainers have the right and responsibility to remove, edit, or
63-
reject comments, commits, code, wiki edits, issues, and other contributions
64-
that are not aligned to this Code of Conduct, or to ban temporarily or
65-
permanently any contributor for other behaviors that they deem inappropriate,
66-
threatening, offensive, or harmful.
67-
68-
### Scope
69-
70-
This Code of Conduct applies both within project spaces and in public spaces
71-
when an individual is representing the project or its community. Examples of
72-
representing a project or community include using an official project e-mail
73-
address, posting via an official social media account, or acting as an appointed
74-
representative at an online or offline event. Representation of a project may be
75-
further defined and clarified by project maintainers.
76-
77-
### Enforcement
78-
79-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
80-
reported by contacting the project team at [email protected]. All
81-
complaints will be reviewed and investigated and will result in a response that
82-
is deemed necessary and appropriate to the circumstances. The project team is
83-
obligated to maintain confidentiality with regard to the reporter of an incident.
84-
Further details of specific enforcement policies may be posted separately.
85-
86-
Project maintainers who do not follow or enforce the Code of Conduct in good
87-
faith may face temporary or permanent repercussions as determined by other
88-
members of the project's leadership.
89-
90-
### Attribution
91-
92-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
93-
available at [http://contributor-covenant.org/version/1/4][version]
94-
95-
[homepage]: http://contributor-covenant.org
96-
[version]: http://contributor-covenant.org/version/1/4/
10+
Please see [testing.md](TESTING.md) for full testing instructions. Your contributions should be able to pass every test.

TESTING.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
11
# Testing
22

3-
We use [Spek](https://github.com/spekframework/spek) to run unit tests. You must add Maven Central to the gradle repositories
4-
in order to pull Spek.
3+
We use the multiplatform kotlin.test framework to run tests.
54

65
You must create a Spotify application [here](https://developer.spotify.com/dashboard/applications) to get credentials.
76

8-
To run **only** public endpoint tests, run
7+
To run **only** public endpoint tests, you only need `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET` as environment variables.
98

10-
`gradle jvmTest` and `gradle testDebugUnitTest`
9+
To additionally run **all** private (client) endpoint tests, you need a valid Spotify application, redirect uri, and token string.
10+
The additional environment variables you will need to add are `SPOTIFY_REDIRECT_URI` and `SPOTIFY_TOKEN_STRING`.
1111

12-
Note: You must have `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET` as environment variables.
12+
Some tests may fail if you do not allow access to all required scopes. To mitigate this, you can individually grant
13+
each scope or use the following code snippet to print out the Spotify token string (given a generated authorization code).
14+
However, you can painlessly generate a valid token by using the [spotify-web-api-token-helper](https://github.com/adamint/spotify-web-api-token-helper)
15+
library.
1316

14-
To run **all** tests, you need a valid Spotify application, redirect uri, and token string. use:
1517

16-
`gradle jvmTest` and `gradle testDebugUnitTest`
18+
To run tests, run `gradle check`
1719

18-
Note: In addition to `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET`, you also must have the following environment
19-
variables set up: `SPOTIFY_REDIRECT_URI` and `SPOTIFY_TOKEN_STRING`
20-
21-
Some tests may fail if you do not allow access to all required scopes. To mitigate this, you can individually grant
22-
each scope or use the following code snippet to print out the Spotify token string (given a generated authorization code)
2320

2421
To build the maven artifact locally, you will need to follow these steps:
2522
- Create `gradle.properties` if it doesn't exist already.
26-
- Follow [this guide](https://gist.github.com/phit/bd3c6d156a2fa5f3b1bc15fa94b3256c). Instead of `.gpg` extension, use `.kbx` for your secring.
23+
- Follow [this guide](https://gist.github.com/phit/bd3c6d156a2fa5f3b1bc15fa94b3256c). Instead of `.gpg` extension, use `.kbx` for your secring.
24+
- Run `gradle publishToMavenLocal`
25+
26+
You can use this artifact to test locally by adding the `mavenLocal()` repository in any local gradle project.
27+
28+
To build docs, run `gradle dokkaHtml`. They will be located under the docs directory in the repostiory root, and
29+
are ignored. This is how we generate release docs.

0 commit comments

Comments
 (0)