Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc | Create a "Contributing" section #150

Open
juanmatias opened this issue Feb 10, 2023 · 2 comments
Open

Doc | Create a "Contributing" section #150

juanmatias opened this issue Feb 10, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation patch

Comments

@juanmatias
Copy link
Contributor

juanmatias commented Feb 10, 2023

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/

@exequielrafaela
Copy link
Member

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation patch
Projects
None yet
Development

No branches or pull requests

2 participants