Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #155

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update readme #155

wants to merge 2 commits into from

Conversation

irina-baeva
Copy link
Member

The purpose of the PR is to update the README with up-to-date information regarding the project local installation.

@irina-baeva irina-baeva requested a review from a team as a code owner January 15, 2025 10:25
@jmcodingde
Copy link
Contributor

jmcodingde commented Jan 15, 2025

Those additions to the readme are helpful for our internal development, thank you for adding them @irina-baeva !

We have to keep in mind that this repo is public on GitHub and it also pushes the public npm package @getsupertab/supertab-browser.

The readme is published on npm as is and in that context we're addressing external developers. For them, bun is not a requirement and they are probably mostly interested in how to install the package as a dependency and how to use it rather than how to contribute.

Maybe we could put those (internal) development instructions into a separate section and focus on the external developer audience in the rest of the readme

@jmcodingde
Copy link
Contributor

jmcodingde commented Jan 15, 2025

If we want to trigger a version bump and create a new release, the PR title (i.e. the final commit message title after squashing) has to conform to the semantic commit message format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants