Skip to content

Commit c4fcbf6

Browse files
committed
Add ideas for improvements in README.md file
1 parent ee76676 commit c4fcbf6

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,8 +298,26 @@ For larger datasets or high-performance requirements, consider using a dedicated
298298

299299
## Contributing
300300

301-
Contributions are welcome! Please feel free to submit a Pull Request.
301+
Contributions are welcome! Here are some ways you can help improve JsonFileCRUD:
302+
303+
### Ideas for Contributions
304+
305+
- **TypeScript Support**: Add TypeScript type definitions (.d.ts files)
306+
- **Async/Await Support**: Add Promise-based API alongside callbacks
307+
- **Batch Operations**: Add bulk insert/update/delete operations
308+
- **File Locking**: Add file locking for multi-process safety
309+
- **Documentation**: Improve documentation and add more examples
310+
311+
### How to Contribute
312+
313+
1. **Fork the Repository**: Create your own fork of the project
314+
2. **Create a Feature Branch**: `git checkout -b feature/your-feature-name`
315+
3. **Write Tests**: Ensure your changes are well-tested
316+
4. **Follow Code Style**: Keep the code clean and consistent
317+
5. **Update Documentation**: Add or update relevant documentation
318+
6. **Submit a Pull Request**: Describe your changes clearly
302319

303320
## License
304321

305322
MIT License - see [LICENSE](./LICENSE) file for details.
323+

0 commit comments

Comments
 (0)