You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
## Description
2
2
3
3
<!--
4
-
Thanks for contributing to Clerk. Make sure to read the contributing guide at https://github.com/clerkinc/javascript/blob/main/docs/CONTRIBUTING.md before opening a PR!
4
+
Thanks for contributing to Clerk. Make sure to read the contributing guide at https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md before opening a PR!
5
5
6
6
**Please create a feature request before starting work on any significant change.**
7
7
@@ -18,7 +18,7 @@
18
18
-[ ]`npm test` runs as expected.
19
19
-[ ]`npm run build` runs as expected.
20
20
-[ ] (If applicable) [JSDoc comments](https://jsdoc.app/about-getting-started.html) have been added or updated for any package exports
21
-
-[ ] (If applicable) [Documentation](https://github.com/clerkinc/clerk-docs) has been updated
21
+
-[ ] (If applicable) [Documentation](https://github.com/clerk/clerk-docs) has been updated
Copy file name to clipboardExpand all lines: .github/workflows/lock-threads.yml
+2-2
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ jobs:
33
33
34
34
We currently close issues after 40 days of inactivity. It's been 30 days since the last update here. If we missed this issue, please reply here. Otherwise, we'll close this issue in 10 days.
35
35
36
-
As a friendly reminder: The best way to see an issue fixed is to open a pull request. If you're not sure how to do that, please check out our [contributing guide](https://github.com/clerkinc/javascript/blob/main/docs/CONTRIBUTING.md).
36
+
As a friendly reminder: The best way to see an issue fixed is to open a pull request. If you're not sure how to do that, please check out our [contributing guide](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md).
37
37
38
38
Thanks for being a part of the Clerk community! 🙏
39
39
stale-pr-message: |
@@ -47,7 +47,7 @@ jobs:
47
47
48
48
After 40 days of no activity, we'll close this issue. Keep in mind, I'm just a robot, so if I've closed this issue in error, please reply here and my human colleagues will reopen it.
49
49
50
-
As a friendly reminder: The best way to see an issue fixed is to open a pull request. If you're not sure how to do that, please check out our [contributing guide](https://github.com/clerkinc/javascript/blob/main/docs/CONTRIBUTING.md).
50
+
As a friendly reminder: The best way to see an issue fixed is to open a pull request. If you're not sure how to do that, please check out our [contributing guide](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md).
Copy file name to clipboardExpand all lines: README.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -55,16 +55,16 @@ Clerk's full documentation is available at [clerk.com/docs](https://clerk.com/do
55
55
56
56
## 🚢 Release Notes
57
57
58
-
Curious what we shipped recently? You can browse the [GitHub Releases](https://github.com/clerkinc/javascript/releases) page or look at the individual `CHANGELOG.md` files inside each package (e.g. [`clerk-js CHANGELOG`](https://github.com/clerkinc/javascript/blob/main/packages/clerk-js/CHANGELOG.md)).
58
+
Curious what we shipped recently? You can browse the [GitHub Releases](https://github.com/clerk/javascript/releases) page or look at the individual `CHANGELOG.md` files inside each package (e.g. [`clerk-js CHANGELOG`](https://github.com/clerk/javascript/blob/main/packages/clerk-js/CHANGELOG.md)).
59
59
60
60
## 🤝 How to Contribute
61
61
62
-
We're open to all community contributions! If you'd like to contribute in any way, please read [our contribution guidelines](https://github.com/clerkinc/javascript/blob/main/docs/CONTRIBUTING.md). We'd love to have you as part of the Clerk community!
62
+
We're open to all community contributions! If you'd like to contribute in any way, please read [our contribution guidelines](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md). We'd love to have you as part of the Clerk community!
63
63
64
64
It'll show you how to make changes to the SDKs, open pull requests, or submitting issues. If you want to add or edit localizations (e.g. how a button text is translated to your language), you can check out the [`localizations` README](./packages/localizations/README.md).
65
65
66
66
## 📝 License
67
67
68
68
This project is licensed under the **MIT license**.
69
69
70
-
See [LICENSE](https://github.com/clerkinc/javascript/blob/main/LICENSE) for more information.
70
+
See [LICENSE](https://github.com/clerk/javascript/blob/main/LICENSE) for more information.
Copy file name to clipboardExpand all lines: docs/CICD.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -9,24 +9,24 @@ Every time a PR is merged into `main`, an automated staging release will happen.
9
9
10
10
## Stable releases
11
11
12
-
A stable release will be triggered every time the "Version Packages" PR is merged. Once versioning and publishing is done, the `clerkinc/javascript` repo will dispatch a workflow event, notifying other related Clerk repos of the new releases.
12
+
A stable release will be triggered every time the "Version Packages" PR is merged. Once versioning and publishing is done, the `clerk/javascript` repo will dispatch a workflow event, notifying other related Clerk repos of the new releases.
13
13
14
14
Actions that will be triggered:
15
15
16
-
-`clerkinc/cloudflare-workers`: The latest clerk-js versions in `clerkjs-proxy/wrangler.toml` will be updated a PR will open. Follow the instructions in the PR to manually release a new `clerkjs-proxy` worker.
16
+
-`clerk/cloudflare-workers`: The latest clerk-js versions in `clerkjs-proxy/wrangler.toml` will be updated a PR will open. Follow the instructions in the PR to manually release a new `clerkjs-proxy` worker.
17
17
18
-
For more details, refer to [PUBLISH.md](https://github.com/clerkinc/javascript/blob/main/docs/PUBLISH.md).
18
+
For more details, refer to [PUBLISH.md](https://github.com/clerk/javascript/blob/main/docs/PUBLISH.md).
19
19
20
20
## Automated staging releases
21
21
22
-
A staging release will be triggered every time PR is merged into `main`. Once versioning and publishing is done, the `clerkinc/javascript` repo will dispatch a workflow event, notifying other related Clerk repos of the new releases.
22
+
A staging release will be triggered every time PR is merged into `main`. Once versioning and publishing is done, the `clerk/javascript` repo will dispatch a workflow event, notifying other related Clerk repos of the new releases.
23
23
24
24
Actions that will be triggered:
25
25
26
-
-`clerkinc/cloudflare-workers`: The latest clerk-js versions in `clerkjs-proxy/wrangler.toml` will be updated and directly committed to `main`. A second workflow will perform a staging release of the `clerkjs-proxy` worker.
27
-
-`clerkinc/accounts`: A new Accounts deployment will take place, using the most recent staging `@clerk/nextjs` version. This change will not be committed to `main`.
26
+
-`clerk/cloudflare-workers`: The latest clerk-js versions in `clerkjs-proxy/wrangler.toml` will be updated and directly committed to `main`. A second workflow will perform a staging release of the `clerkjs-proxy` worker.
27
+
-`clerk/accounts`: A new Accounts deployment will take place, using the most recent staging `@clerk/nextjs` version. This change will not be committed to `main`.
28
28
29
-
For more details about staging releases, refer to [PUBLISH.md](https://github.com/clerkinc/javascript/blob/main/docs/PUBLISH.md).
29
+
For more details about staging releases, refer to [PUBLISH.md](https://github.com/clerk/javascript/blob/main/docs/PUBLISH.md).
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Contributing guide
2
2
3
3
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
4
-
Please note we have a [code of conduct](https://github.com/clerkinc/javascript/blob/main/docs/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
4
+
Please note we have a [code of conduct](https://github.com/clerk/javascript/blob/main/docs/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
5
5
6
6
<detailsopen="open">
7
7
<summary><strong>TABLE OF CONTENTS</strong></summary>
@@ -57,7 +57,7 @@ To set up your development environment, please follow these steps:
2. Install the dependencies. We're using npm workspaces, so you **should always run `npm install` from the root of the monorepo**, as it will install dependencies for all the packages:
@@ -77,21 +77,21 @@ For package specific setup, refer to the `Build` section of the specific package
77
77
78
78
### Documenting your changes
79
79
80
-
Updating documentation is an important part of the contribution process. If you are changing existing behavior or adding a new feature, make sure [Clerk's documentation](https://github.com/clerkinc/clerk-docs) is also updated.
80
+
Updating documentation is an important part of the contribution process. If you are changing existing behavior or adding a new feature, make sure [Clerk's documentation](https://github.com/clerk/clerk-docs) is also updated.
81
81
82
82
To improve the in-editor experience when using Clerk's SDKs, we do our best to add [JSDoc comments](https://jsdoc.app/about-getting-started.html) to our package's public exports. The JSDoc comments should not attempt to duplicate any existing type information, but should provide meaningful additional context or references. If you are adding a new export, make sure it has a JSDoc comment. If you are updating an existing export, make sure any existing comments are updated appropriately.
that relate to your submission. You don't want to duplicate effort.
89
89
2. Fork the project
90
90
3. Create your feature branch (`git checkout -b feat/amazing_feature`)
91
91
4. If required, create a `changeset` that describes your changes (`npm run changeset`). In cases where a changeset is not required, an empty changeset can be created instead (`npm run changeset:empty`) - an empty changeset will not generate a changelog entry for the change, so please use it as an escape hatch or for internal refactors only.
92
92
5. Commit your changes (`git commit -m 'feat: Add amazing_feature'`)
93
93
6. Push to the branch (`git push origin feat/amazing_feature`)
94
-
7.[Open a Pull Request](https://github.com/clerkinc/javascript/compare?expand=1). Make sure the description includes enough information for the reviewer to understand what the PR is about.
94
+
7.[Open a Pull Request](https://github.com/clerk/javascript/compare?expand=1). Make sure the description includes enough information for the reviewer to understand what the PR is about.
95
95
8. Follow the instructions of the pull request template
96
96
97
97
### Changesets
@@ -172,7 +172,7 @@ All of these are used to describe changes in the codebase, but they have differe
172
172
173
173
## Issues and feature requests
174
174
175
-
You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/clerkinc/javascript/issues). Before you create an issue, make sure to search the issue archive - your issue may have already been addressed! Please ensure that you have read and followed the bug report template, otherwise we will have to close the issue. You can submit a feature request by visiting [feedback.clerk.com](https://feedback.clerk.com).
175
+
You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by [submitting an issue on GitHub](https://github.com/clerk/javascript/issues). Before you create an issue, make sure to search the issue archive - your issue may have already been addressed! Please ensure that you have read and followed the bug report template, otherwise we will have to close the issue. You can submit a feature request by visiting [feedback.clerk.com](https://feedback.clerk.com).
176
176
177
177
Issues that have the label `needs-triage` have been seen by our team and are queued for triage internally. Issues that have the label `prioritized` have been discussed and are either in our backlog or being worked on actively. We do our best to prioritize work across a wide variety of sources, only one of which is github issues. While we understand that it can be frustrating if it takes a while for a patch to land, we ask for your understanding in that we have quite a lot of things that need to be worked on at any given time and are still a small team. And remember, the best way to get something fixed in an open source library is to contribute the fix yourself!
178
178
@@ -186,7 +186,7 @@ If you want to add or edit localizations (e.g. how a button text is translated t
186
186
187
187
_Note: Only core maintainers can publish packages._
188
188
189
-
For more information visit [publish documentation](https://github.com/clerkinc/javascript/blob/main/docs/PUBLISH.md).
189
+
For more information visit [publish documentation](https://github.com/clerk/javascript/blob/main/docs/PUBLISH.md).
Copy file name to clipboardExpand all lines: docs/PUBLISH.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Snapshot releases are a way to release your changes for testing without updating
26
26
**Important:**
27
27
Before requesting a snapshot release, ensure that your Clerk organization membership status is set to "Public". Otherwise, the snapshot release will fail. To set your status to "Public", follow [these steps](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/publicizing-or-hiding-organization-membership).
28
28
29
-
To perform a snapshot release, simply comment `!snapshot` in your PR. Once the packages are built and published (~2mins), [clerk-cookie](https://github.com/clerk-cookie) will post a reply with the published versions ([example](https://github.com/clerkinc/javascript/pull/1329#issuecomment-1586970784)). Simply install the snap version using `npm install` as usual.
29
+
To perform a snapshot release, simply comment `!snapshot` in your PR. Once the packages are built and published (~2mins), [clerk-cookie](https://github.com/clerk-cookie) will post a reply with the published versions ([example](https://github.com/clerk/javascript/pull/1329#issuecomment-1586970784)). Simply install the snap version using `npm install` as usual.
30
30
31
31
Notes:
32
32
@@ -45,7 +45,7 @@ We're still considering whether switching the repo into a `canary` mode for big,
45
45
46
46
> Backporting is the action of taking parts from a newer version of a software system or software component and porting them to an older version of the same software.
47
47
48
-
If a PR got merged into `main` that should also be released in older versions (e.g. critical security fixes), you'll need to backport said PR. You can do this by using the [`backport` script](https://github.com/clerkinc/javascript/blob/main/scripts/backport.mjs) inside `scripts`.
48
+
If a PR got merged into `main` that should also be released in older versions (e.g. critical security fixes), you'll need to backport said PR. You can do this by using the [`backport` script](https://github.com/clerk/javascript/blob/main/scripts/backport.mjs) inside `scripts`.
49
49
50
50
Duplicate the `.env.example` file inside `scripts` and rename it to `.env`. Fill out the `GITHUB_ACCESS_TOKEN` variable. Afterwards, you'll be able to run the CLI like so:
0 commit comments