From the EFDE team we thank you for taking the time to collaborate with the project
We like our community to report issues and send us pull requests.
Below is a series of guidelines for contributing to EFDE admin by @mmaximo33 which is only hosted on GitHub.
This series of guidelines or steps to follow are suggestions for reporting problems, promoting improvements or requesting new features. They are not strict rules.
Before submitting, please review the following:
You can get involved with the project in many ways, here are some suggestions of things we would like to receive help with.
You can consider helping out with issues already requiring attention - look for a "help wanted" label.
The collaboration of those who wish to improve the documentation is always welcome.
- Adding those implicit.
- Correcting sequences
- Making it more coherent and consistent
Please explain the issue and include additional details to help maintainers or any community members reproduce the issue.
Don't worry, there is a template to report an issue, anyway, below we give a brief detail of what is expected
| Element | Description | Pather | Example |
|---|---|---|---|
| Title | It is important to have a clear and descriptive title to identify the problem |
Scope: Action - issue You can see the scope in the labels with the prefix x |
- Efde: Install - Incompatible with windows 10 - Symfony: Console - Does not run custom commands |
| Description | A clear and concise description of the bug. | - |
Trying to install the symfony environment the following error occurs ` Error in console ` |
| How to Reproduce |
Describe the exact steps which reproduce the problem in as many details as possible When listing steps, don't just say what you did, but explain how you did it. |
1. Previous 2. Moment 3. Following |
1. Enter my project created with efde 2. Run $efde 3. When indicating option 1 of the menu (example action) 4. Returned the following error... |
| Expected behavior | Describe what was the behavior you expected for said action | - | After indicating action 1 (example action) you should perform ... |
| Visual evidence | Supporting what is reported with visual evidence can often give a quick indication of what the real problem might be. |
- Screenshots - Videos |
Attached evidence of the problem detected - Attach video - Attach images |
| System Information | Provide the output of the `efde --debug` command |
- efde --version - Operating system and version - bash --version - python3 --version - docker --version - others |
- efde v1.2.0 - Ubuntu 22.04 - GNU bash, version 5.1.16(1)-release - Python 3.10.6 - Docker version 23.0.1, build a5ee5b1 - Docker Compose version v2.16.0 - others |
| Additional Context | Add any other context about the problem here. | - | I am running EFDE in a virtual machine from MAC/Windows ... |
Don't forget to check our Code of Conduct