fyp-package-template

Community | Documentation | Resources | Contributors | Release Notes

One paragraph definition.

Installation

Please follow the Installation Guide.

Contributing

We welcome contributions including bug reports, bug fixes, documentation improvements, enhances and ideas from new contributors of all experience levels. The goals are to be helpful, welcoming, and effective. The Development Guide has detailed information about contributing code, documentation, tests, and more. We've included some basic information in this README and CHANGELOG file.

Basic steps

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/FeatureName)
3. Commit your Changes (git commit -m 'Add some FeatureName')
4. Push to the Branch (git push origin feature/FeatureName)
5. Open a Pull Request

Testing

You can launch the test suite from the main directory running pytest.

Useful links

• Official source code repo: https://github.com/<github_username>/<repository_name>
• Download releases: https://github.com/<github_username>/<repository_name>/releases
• Issue tracker: https://github.com/<github_username>/<repository_name>/issues

License

Distributed under the GNU v3.0 License. See LICENSE for more information.

Changelog

Link to release history and/or CHANGELOG

Roadmap

Acknowledgements

Contributors

Support

FAQ

Contact