Skip to content

Commit 0004204

Browse files
authored
chore: add contributing guide (#977)
fixed #920
1 parent ef3f57e commit 0004204

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

.github/CONTRIBUTING.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# (Draft) Contribute to Logto JavaScript SDKs monorepo
2+
3+
Thanks for your interest in contributing to Logto. We respect the time of community contributors, so it'll be great if we can go through this guide which provides the necessary contribution information before starting your work.
4+
5+
This repository contains the source code of Logto JavaScript SDKs. For other languages, please refer to the [Logto organization](https://github.com/logto-io) for more information.
6+
7+
**Table of contents**
8+
9+
- [(Draft) Contribute to Logto JavaScript SDKs monorepo](#draft-contribute-to-logto-javascript-sdks-monorepo)
10+
- [Contribution Type](#contribution-type)
11+
- [Bug fixes](#bug-fixes)
12+
- [New SDKs](#new-sdks)
13+
- [SDK updates](#sdk-updates)
14+
- [Set up a Logto instance](#set-up-a-logto-instance)
15+
- [Make changes](#make-changes)
16+
- [Test the changes](#test-the-changes)
17+
- [Run the sample project](#run-the-sample-project)
18+
- [Commit and create pull request](#commit-and-create-pull-request)
19+
20+
## Contribution Type
21+
22+
### Bug fixes
23+
24+
We ensure most of the SDKs run correctly with unit tests and sample projects. However, there's still a chance of missing or getting wrong on something.
25+
26+
If something doesn't work as expected, search in [Issues](https://github.com/logto-io/js/issues) to see if someone has reported the issue.
27+
28+
- If an issue already exists, comment to say you're willing to take it.
29+
- If not, create one before continuing. It'll be great to let other people know you found it and will fix it.
30+
31+
Usually, we'll confirm the details in the issue thread, and you can work on the Pull Request in the meantime.
32+
33+
> **Warning**
34+
>
35+
> Do not report a security issue directly in the public GitHub Issues, since someone may take advantage of it before the fix. Send an email to [security@logto.io](mailto:security@logto.io) instead.
36+
37+
### New SDKs
38+
39+
Logto covers lots of platforms and frameworks, so we're always looking for new SDKs to support.
40+
41+
Before starting the work, join our [Discord channel](https://discord.gg/cyWnux4cH6) or [email us](mailto:contact@logto.io) to double-check if there's an ongoing project for your desired SDK. We'll confirm with you your need and the status quo.
42+
43+
### SDK updates
44+
45+
If you can find an SDK, but it's not up to date to the target platform or framework, you can update it.
46+
47+
## Set up a Logto instance
48+
49+
Before starting the work, we suggest you to set up a Logto instance to test the SDK. You can either use the [Logto Cloud](https://cloud.logto.io) or [Logto OSS](https://docs.logto.io/introduction/set-up-logto-oss). Then prepare an application for your SDK in the Admin Console. Have the necessary information ready, such as the application ID, application secret, and Logto endpoint.
50+
51+
## Make changes
52+
53+
Go to the folder of the SDK you want to work on, and start to make changes.
54+
55+
## Test the changes
56+
57+
Run the unit tests to make sure the changes are working as expected.
58+
59+
## Run the sample project
60+
61+
Build your SDK and run the sample project to make sure the SDK is working as expected.
62+
63+
## Commit and create pull request
64+
65+
We require every commit to [be signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits), and both the commit message and pull request title follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary).
66+
67+
You can find repo-specific config in `commitlint.config.js`, if applicable.
68+
69+
If the pull request remains empty content, it'll be DIRECTLY CLOSED until it matches our contributing guideline.

0 commit comments

Comments
 (0)