Thank you for considering contributing to this Node.js project! Here are some guidelines to help you get started.
Please read and follow this Code of Conduct to ensure a welcoming environment for all contributors.
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include:
- A descriptive title and summary.
- Steps to reproduce the issue.
- Any relevant logs, screenshots, or other information.
- Check if the enhancement was already suggested by searching on GitHub under Issues.
- If not, open a new issue and provide:
- A clear and descriptive title.
- A detailed description of the enhancement.
- Any relevant examples or use cases.
- Fork the repository and create your branch from
main. - Follow the project's coding style and conventions.
- Ensure your code passes all tests and add new tests if necessary.
- Update the documentation if needed.
- Submit your pull request, linking to the issue it addresses.
- Clone the repository:
git clone https://github.com/santospatrick/notify.git
- Install dependencies:
yarn install
- For local development:
yarn dev
- Run build:
yarn build
- Follow this project lint configuration, provided by ESLint.
- Use meaningful commit messages.
By contributing, you agree that your contributions will be licensed under the MIT License.
Thank you for your contributions!