We appreciate your valuable input! Let's build a community that cares about
the natural disaster affected people of Bangladesh.
I want to make contributing to this project as easy and transparent
as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Suggesting architectural improvements
- Becoming a maintainer
Github flow will be maintained. So, all contributions will be integrated through pull requests
Pull requests are the best way to propose changes to the codebase. I will be actively looking for your pull requests:
- Analyze the open issues and choose one for making a contribution
- If you feel something novel need to be done then discuss with other collaborators and then create the issue
- Join the communication platform (currently it's slack) being used by the collaborators
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Create a pull request with necessary descriptions, images etc so that it's clear what you have done!
- PRs without proper documentation will not be accepted.
Let's use GitHub issues to track public bugs. Report a bug by opening a new issue.
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can. This bug report includes sample code that anyone with standard Python setup can run to reproduce the issue.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
People love thorough bug reports. I'm not even kidding.
- Try to follow standard Python coding practices and Standard TS best practices
- Use multiple lines for specifying more than 3 parameters in functions
- Don't use more than 80 characters in a single line of code
- Use descriptive variable names
Feature requests are highly appreciated. I would love to hear about how you might use this tool in your professional/research work. The project issue tracker can be used for feature requests also.
- Provide the specific use cases of the requested features in details
- You may also suggest slight enhancements of existing features
- Mention how these features add value to your profession/research work
By contributing, you agree that your contributions will be licensed under its BSD 3 License. In short, when you submit code changes, your submissions are understood to be under the same BSD-3 License that covers the project. Feel free to contact the maintainers if that's a concern.