Contributing
Welcome to the deepsearchjs contribution guide. deepsearchjs is a TypeScript library that allows for searching deeply-nested objects.
Getting Started
To get started contributing to deepsearchjs, you'll need to do the following:
Clone the repository:
git clone https://github.com/wise-introvert/deepsearchjs.gitInstall dependencies:
yarninstallBuild the library:
yarn buildRun the tests:
yarn test
Make sure that all tests pass before creating a pull request.
Code of Conduct
We expect all contributors to follow our code of conduct. This project adheres to the Contributor Covenant. By participating, you are expected to uphold this code.
Issues and Bugs
If you find an issue or a bug, please submit it in the Issues section of the repository. When submitting an issue, please include the following information:
A clear and concise description of the problem
Steps to reproduce the issue
Expected behavior
Actual behavior
Screenshots or GIFs, if applicable
Additional context or information
Feature Requests
We welcome feature requests. To submit a feature request, please open an issue in the Issues section of the repository and include the following information:
A clear and concise description of the feature
Use cases for the feature
Additional context or information
Pull Requests
We welcome pull requests. Before submitting a pull request, please make sure to do the following:
Fork the repository
Create a new branch for your changes
Make your changes
Run the tests and make sure they pass
Update the documentation, if necessary
Submit the pull request to the
masterbranch
Please be aware that your pull request will be reviewed and may be commented on or requested changes before being accepted.
Code Style and Conventions
We follow the Airbnb JavaScript Style Guide for this project. Please make sure your code adheres to the same style guide before submitting a pull request.
Acknowledgements
Contact
If you have any questions or concerns, please reach out to the maintainers of this project:
Last updated