Contributing

When contributing to this project, please first discuss the change you wish to make via GitHub discussions, email, or any other method with the owners of this repository before making a change. The contribution can be the report of a bug, the request for a new feature or modifying the code of the framework to improve it.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.

  2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.

  3. Update the documentation in the same Pull Request

  4. Don’t forget to add unit tests.

  5. Create a new branch and a Pull Request to merge your work on the dev branch of the project.

You want to share a bug ?

You can create an issue with all information that can help us to understand your request. Share with us the following information:

  • version of python

  • version of the framework

  • operating system

  • the error raised by your code

  • all steps to reproduce the bug

Support

If you have any questions about the project, don’t hesitate to create a new discussion with GitHub Discussions (https://github.com/moead-framework/framework/discussions). It is the space for our community to have conversations, ask questions and post answers without opening issues.

Code of Conduct

The code of conduct is available here: https://github.com/moead-framework/framework/blob/master/CODE_OF_CONDUCT.md.