chore: update contribution guide lines #6984
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
✅ Deploy Preview for tiptap-embed ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
@tiptap/extension-character-count
@tiptap/extension-focus
@tiptap/extension-dropcursor
@tiptap/extension-gapcursor
@tiptap/extension-history
@tiptap/extension-list-item
@tiptap/extension-list-keymap
@tiptap/extension-placeholder
@tiptap/extension-table-header
@tiptap/extension-table-cell
@tiptap/extension-table-row
@tiptap/extension-task-item
@tiptap/extension-task-list
@tiptap/core
@tiptap/extension-blockquote
@tiptap/extension-bubble-menu
@tiptap/extension-bold
@tiptap/extension-bullet-list
@tiptap/extension-code
@tiptap/extension-code-block-lowlight
@tiptap/extension-code-block
@tiptap/extension-collaboration
@tiptap/extension-collaboration-caret
@tiptap/extension-color
@tiptap/extension-details
@tiptap/extension-document
@tiptap/extension-drag-handle
@tiptap/extension-drag-handle-react
@tiptap/extension-drag-handle-vue-2
@tiptap/extension-emoji
@tiptap/extension-drag-handle-vue-3
@tiptap/extension-file-handler
@tiptap/extension-floating-menu
@tiptap/extension-hard-break
@tiptap/extension-font-family
@tiptap/extension-heading
@tiptap/extension-highlight
@tiptap/extension-horizontal-rule
@tiptap/extension-image
@tiptap/extension-invisible-characters
@tiptap/extension-italic
@tiptap/extension-link
@tiptap/extension-list
@tiptap/extension-mention
@tiptap/extension-mathematics
@tiptap/extension-node-range
@tiptap/extension-ordered-list
@tiptap/extension-paragraph
@tiptap/extension-strike
@tiptap/extension-subscript
@tiptap/extension-superscript
@tiptap/extension-table
@tiptap/extension-table-of-contents
@tiptap/extension-text
@tiptap/extension-text-align
@tiptap/extension-text-style
@tiptap/extension-underline
@tiptap/extension-typography
@tiptap/extension-unique-id
@tiptap/extension-youtube
@tiptap/html
@tiptap/extensions
@tiptap/pm
@tiptap/react
@tiptap/starter-kit
@tiptap/suggestion
@tiptap/static-renderer
@tiptap/vue-2
@tiptap/vue-3
commit: |
alexvcasillas
approved these changes
Sep 19, 2025
arnaugomez
requested changes
Sep 19, 2025
| - Check the codebase to ensure that your feature doesn't already exist. | ||
| - Check the pull requests to ensure that another person hasn't already submitted the feature or fix. | ||
|
|
||
| Branch targets: Pull requests should generally be opened against the `develop` branch. The only exception is a hotfix that needs to be applied immediately to `main`; in that case create the PR against `main`. After `main` has been updated (for example via a release), any commits merged into `main` must be merged back into `develop` to keep branches in sync. |
There was a problem hiding this comment.
If the change is breaking the PR would be done towards next branch right?
|
|
||
| This repository uses Changesets to manage releases. Contributors should add a changeset for any package-level change they expect to be published; these changesets are collected and drive our release process. | ||
|
|
||
| Only pull requests that include a changeset will be considered for a release. If a pull request does not contain a changeset, it will not trigger a package release and therefore will not be included in the next release cycle. |
There was a problem hiding this comment.
Maybe we should add this to the "Before submitting a pull request" section instead of here
|
|
||
| ### Release procedure (step-by-step) | ||
|
|
||
| 1. Create one or more changesets for the package changes you want published. Use the `changeset` CLI or the web workflow to generate a changeset file that describes the change and the desired version bump. |
There was a problem hiding this comment.
This should be done when creating a PR, not when doing a release, right? Maybe we should remove this step from this section?
| 2. Open a pull request with your changes and include the changeset file(s) in the PR. Ensure tests and linters pass before requesting review. | ||
| 3. After the PR is reviewed and approved, merge it into the default branch. Only PRs that include changesets will be considered for release. | ||
| 4. When changesets are merged into the default branch, the Changesets tooling will create a Release PR that aggregates proposed version bumps and compiled changelog entries for all affected packages. | ||
| 5. Review the Release PR carefully. Verify that the version bumps, changelog entries, and affected packages are correct. Clean up any noisy dependency-only bumps from the changelog if appropriate. |
There was a problem hiding this comment.
Clean up any noisy dependency-only bumps from the changelog if appropriate.
This should be done when creating the release, or by editing the PR description?
|
I think the guide is missing an explanation on what difference there is between main/develop/next branches. I have doubts whether |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.