First off, thanks for taking the time to contribute! ❤️
- You can email me before doing anything else.
- Never do a pull request on master/main/stable branches. (do it on 'dev' branch)
- Before any commit
- make sure you are passing all tests by running: 'make test'
- make sure the code is formatted correctly by running 'make fmt'
- you can config your text editor/IDE to run 'cargo fmt' file save event
- make sure there is no clippy warning (optional)
- If you need to do a breaking change let me know before doing anything. (we will make a new branch for it and add that to next major update X.x.x)
- Add module-name to Cargo.toml at features section with list of dependencies
- Add module-name to Cargo.toml at features under 'full' feature
- Add module-name to Makefile to the end of build task
- Add your module build test to end of file (checkout other build task)
- Add 'pub mod module-name' to end of lib.rs
- Add your module-name to the beginning of the lib.rs under '#[cfg(not(any())]'
- Make a Pull request
- Implement your feature
- Add tests for your feature
- Add standard function docs to your public functions
- Make an issue on this repository and describe this bug (make sure its actually a bug and not a feature😄)
- Write a test and make it fail
- Make a pull request
- Try to fix it and pass the test or tell me to do that
Lets say there is a new bank or city or... out there and its not exist in this library
Make an issue on this repository and explain what is missing or wrong.