Skip to content
This repository has been archived by the owner on Aug 26, 2023. It is now read-only.

Add missing CONTRIBUTING.md with contributing guidelines #23

Open
IvoPereira opened this issue Feb 24, 2021 · 2 comments
Open

Add missing CONTRIBUTING.md with contributing guidelines #23

IvoPereira opened this issue Feb 24, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@IvoPereira
Copy link
Member

IvoPereira commented Feb 24, 2021 •
edited
Loading

Description

The current README.md points to CONTRIBUTING.md that hasn't been yet created.

Expected result

Such file should be created and point to clear instructions on what the best practices are for contributing to this repository.

Possible inspirations:
https://github.com/Redocly/redoc/blob/master/.github/CONTRIBUTING.md
@IvoPereira IvoPereira added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 25, 2021
@Alf0nso
Copy link
Member

Alf0nso commented Mar 3, 2021 •
edited
Loading

Readme.md completed properly, at least first draft
closerino

@IvoPereira
Copy link
Member Author

Readme.md completed properly, at least first draft
closerino

However a CONTRIBUTION.md file should still be added with more in-depth instructions on how to contribute, including useful tips like "writing good commit messages".

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@IvoPereira @Alf0nso