UNPKG

@aidenlx/jsonurl

Version:

JSON->URL defines a text format for the JSON data model suitable for use within a URL/URI (as described by RFC3986).

www.jsonurl.org

jsonurl/jsonurl-js

63 lines (57 loc) • 2.85 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
Contributing to jsonurl-js ====================== So you found a bug or want to contribute a new feature? Great! Before you dig into the code there are some guidelines I need contributors to follow so that I have a reasonable chance of keeping things organized without too much effort. Getting Started --------------- + Make sure you have a [GitHub account](https://github.com/signup/free). + If you just want to make a small change see "Making Trivial Changes" below. + See if there is already a [discussion][discussion] or [issue](https://github.com/jsonurl/jsonurl-js/issues), or create a new one if necessary + For defects, clearly describe the problem, including steps to reproduce + For features, clearly describe the idea, including intent, audience, and use cases + If you're planning to implement a new feature it's a good idea to [discuss][discussion] it first. This can help make sure you're not wasting your time on something that's considered out of scope. + Fork the repository on GitHub. Making and Submitting Changes -------------- I accept pull requests via GitHub. Here are some guidelines which will make applying PRs easier for me: + Create a topic/feature branch from the `main` branch to base your work, and push your changes to that branch in your fork of the repository + Make commits of logical units and with [meaningful][commit-message-howto], [conventional commit][cc] messages that reference the related GitHub issue. The following commit types are currently in use: + feat - A new feature + fix - A bug fix + docs - Documentation changes + style - Changes that do not affect code execution (e.g. formatting) + refactor - A code change that neither fixes a bug nor adds a feature + perf - A code change that improves performance + test - A change to test configuration, or one or more files in the `test` directory; must not affect the result of `npm run build` + chore - Changes to the build or workflow process; must not affect the result of `npm run build` + update - dependency update + Use the [style][eslintrc.js] of the existing codebase + Make sure you have added/updated tests for your changes, and that all tests pass + Submit a pull request once you're ready to merge Making Trivial Changes ---------------------- For small changes, like tweaks to comments and/or documentation you don't need to create an issue. A fork + PR with a proper commit message (i.e. docs: ...) is sufficient. [zulip]: https://jsonurl.zulipchat.com/#narrow/stream/248637-jsonurl-js [discussion]: https://github.com/jsonurl/jsonurl-js/discussions [eslintrc.js]: .eslintrc.js [commit-message-howto]: https://chris.beams.io/posts/git-commit/ [semantic-commit-message]: https://seesparkbox.com/foundry/semantic_commit_messages [cc]: https://www.conventionalcommits.org/en/v1.0.0/