Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.95 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with 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

You want to contribute to the framework code ?

You can create an issue with information about the feature or the change you want to make. You can then create a Pull Request with the following process :

  1. Update the README.md with details of changes to the interface, this includes new environment variables and useful file locations.
  2. Update the documentation available in the folder https://github.com/moead-framework/framework/tree/master/docs.
  3. Don't forget to add unit tests.
  4. Create a new branch and a Pull Request to merge your work on the dev branch of the project.

You want to discuss the project ?

If you have any questions about the project, don't hesitate to create a new discussion with the GitHub 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 in this file.