le-ref-architecture-doc
le-ref-architecture-doc copied to clipboard
Doc | Create a "Contributing" section
Describe the Feature
- ✅ Extend and update the current contribute section.
- ✅ Check it's name currently calle "Contribute" to "Contributing" if needed.
- ✅ Includes guidelines to collaborate with binbash projects.
The CONTRIBUTE.md
file in RefArch V1, here, can be used as a base. In any case, this file has to be improved.
As a spin-off of this activity, a new task should be created in each repository, to create/enhance/update the CONTRIBUTE.md
file in each repository.
Expected Behavior
The process to contribute has to be clear to someone reading the docs as well to someone working with a binbash repository.
Use Case
Un usuario dispuesto a contribuir, debe tener una idea clara de cómo hacerlo. Además, las normas y requisitos deben ser lo suficientemente claros para evitar retrasos y otros problemas.
Describe Ideal Solution
A clear and concise description of what you want to happen. If you don't know, that's okay.
Alternatives Considered
n/a
Additional Context
Here it is an interesting CONTRIBUTE.md
generator: https://generator.contributing.md/
And notes https://contributing.md/
@juanmatias 1st version has been included => https://github.com/binbashar/le-ref-architecture-doc/blob/master/CONTRIBUTING.md Not closing this issue since we can probably improve it sgnificantly.
CC: @binbashar/leverage-ref-architecture-aws-admin @binbashar/leverage-ref-architecture-aws-dev
https://binbashar.slack.com/archives/GG0PJ78J3/p1707328532022919?thread_ts=1706788827.003729&cid=GG0PJ78J3