Thank you for taking the time to contribute to my project! ✨
Read the Code of Conduct to maintain a community that is approachable and respectful.
This guide provides an overview of the contribution workflow, from opening an issue to creating a pull request (PR), reviewing it, and merging the PR.
To get an overview of the project, read the README file. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
Refer to the development setup for details on the project structure, scripts, and development environment.
Before making changes, review the existing issues to see the types of contributions that are welcome. Improvements to code, documentation, and tests are all appreciated.
If you spot a problem, search if an issue already exists. If a related issue doesn't exist, please open a new one using a relevant template before submitting a pull request unless the change is truly trivial (for example, typo fixes or removing compiler warnings). Trivial changes don't need an issue or tests.
Browse the existing issues to find one that interests you. You can narrow the search using labels as filters. I add the help wanted label to issues where community contributions are especially welcome and the good first issue label for tasks suited to new contributors. If you'd like to work on an issue, first leave a comment asking if you can work on it. I will assign the issue to you, and once assigned, you can start working on it and open a PR with a fix.
You can make small changes, such as a typo or a broken link, directly through the GitHub UI by clicking Edit this file on the page. This will create a fork and let you create a pull request for review.
You can open this project in a GitHub codespace for a full-featured online development environment.
- Fork the repository:
- Go to https://github.com/martinfrancois/question-driven-talk-assistant.
- Hit the Fork button and choose your own GitHub account as the target. Make sure the box 'Copy main branch' is checked.
- For more details, see fork a repo.
- Clone your fork.
- Follow the development setup in the README to install dependencies and set up your environment. Installing dependencies also sets up a pre-commit hook that formats staged files with Prettier.
- Create a working branch and start making your changes.
Commit your changes and run through this self-review checklist before submitting your PR (you can skip these for trivial changes like typos):
bun lint
bun x tsc -p tsconfig.json --noEmit
bun run build
bun run test:unit
bun x playwright install --with-deps
bun run preview -- --port 5173 # run this in a separate terminal window and keep it open
bun run test:e2e
Write commit messages that follow these guidelines.
Once you've finished your changes, create a pull request.
- Fill out the pull request template so that reviewers can understand your changes.
- Don't forget to link the PR to an issue if you're solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
Once you submit your PR, maintainers will review your proposal and may ask questions or request additional information.
- Maintainers may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments.
- As you update your PR and apply changes, mark each conversation as resolved.
- If you run into any merge conflicts, check out this git tutorial to help you resolve them.
Congratulations 🎉🎉 and thank you for contributing ✨.
Once your PR is merged, your contributions will be publicly visible on the project repository.