Thank you for considering contributing to Notty! Here are some guidelines to help you get started.
- Create a branch with
git checkout -b branch-namewith the name of an issue or feature that you are working on - Add all your changes with
git add . - Commit all your changes with a clear description of what you changed with the command
git commit -m "your description" - Push all your changes to your fork with
git push - Run Tests: Execute
npx cypress runto run all tests. Ensure that all tests pass before proceeding. - TypeScript Imports: When importing modules in TypeScript, include the .js extension, like so:
import { someFunction } from "./index.js";
- At last also exeute
npx prettier . --checkandnpx prettier . --writeto keep the code clean. - Create your PR!
This ensures proper module resolution in the final JavaScript output. Following these steps will help maintain code quality and consistency.
- Search the issues to see if the bug has already been reported.
- If the bug has not been reported, open a new issue and include:
- A clear and descriptive title.
- Steps to reproduce the issue.
- Expected and actual results.
- Any relevant code or screenshots.
- Search the issues to see if the feature has already been requested.
- If the feature has not been requested, open a new issue and include:
- A clear and descriptive title.
- A detailed description of the feature.
- Any relevant examples or use cases.
- Fork the repository and create a new branch for your changes.
- Make your changes and commit them with descriptive messages.
- Push your changes to your forked repository.
- Open a pull request and include:
- A clear and descriptive title.
- A detailed description of the changes.
- Any relevant issues or pull requests.
- Follow the existing code style and conventions.
- Ensure your code is properly formatted and linted.
Thank you for your contributions!