I love to work together with people so if you have an excellent idea for a feature, improvements or maybe you found a bug. Please, don't hesitate in adding an issue, so we can discuss and find a good solution together.
The best way to get started is to look at the issues section and see if the bug or feature you are planning to work with isn't already in development.
When the features and bug are not reported in the issues section, you can start by adding the issue.
To report a bug is simple, add a few things:
- Description of the bug
- Error messages and tracebacks
- Steps to reproduce
- Python version
- System version
If you had a great idea for a feature, I would be thrilled to hear. You can add to the feature description the following information:
- Description of the feature
- Some use cases
- Some examples of how the feature could work
When adding a proposal for a new feature try being as detailed as possible.
The project could always need more detailed and complete documentation. Contributions with docstrings and improving the current documentation on README are very welcome.
If you get an issue to work on, then you can:
- Fork the project
- Create a new branch
- Hack away!
- Submit the pull request when you are ready
- Make sure to add unit tests (if applicable)
- Make sure all tests are passing (Note that the CSV files have to use \r\n as newline)
- Run a code formatter. This project uses black, you can run the command:
black -l 120 -t py39 ./pydantic_csv - Add docstrings for new functions and classes.
- Make sure you follow the PEP 8 Style Guide (run the pre-commit)
Happy Hacking!!!