Contributing#
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
Types of Contributions#
You can contribute in many ways:
Write Documentation#
Flatland could always use more documentation, whether as part of the official Flatland docs, in docstrings, or even on the web in blog posts, articles, and such.
A quick reference for writing good docstrings is available at : docs.python-guide.org/writing/documentation/#writing-docstrings
Fix Bugs#
Look through the Repository Issue Tracker for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Implement Features#
Look through the Repository Issue Tracker for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Report Bugs#
Report bugs at gitlab.aicrowd.com/flatland/flatland/issues
If you are reporting a bug, please include:
Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.
Submit Feedback#
The best way to send feedback is to file an issue at gitlab.aicrowd.com/flatland/flatland/issues.
If you are proposing a feature:
Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome 👼