Thank you for considering contributing to express-yup-middleware! We welcome all kinds of contributions: bug reports, feature requests, documentation improvements, and code contributions.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
If you find a bug in the project, please open an issue and include:
- A clear and descriptive title.
- A detailed description of the bug.
- Steps to reproduce the bug.
- Expected and actual behavior.
- Screenshots, if applicable.
- Any relevant log files or error messages.
To suggest an enhancement, please open an issue and provide:
- A clear and descriptive title.
- A detailed description of the proposed enhancement.
- The motivation for the enhancement (why it would be beneficial).
- Any relevant examples or references.
To submit a pull request:
- Fork the repository.
- Create a new branch for your feature or bugfix.
- Make your changes.
- Ensure all tests pass and add new tests if necessary.
- Commit your changes with a descriptive commit message.
- Push your branch to your forked repository.
- Open a pull request on the main repository and provide a detailed description of your changes.
To set up your development environment:
- Fork and clone the repository.
- Navigate to the project directory.
- Install dependencies using
yarn.
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or less.
- Reference issues and pull requests liberally.
- Consider including links to relevant issues, documentation, or discussions.
We appreciate your effort in making this project better and your contribution is valuable. If you need any help or have questions, feel free to open an issue for support.
Run tests using:
npm test