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.

Sign up for GitHub

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

Jump to bottom

Create CONTRIBUTING.md #158

Open
WilsonCazarre opened this issue Jun 2, 2023 · 0 comments
Open

Create CONTRIBUTING.md #158

WilsonCazarre opened this issue Jun 2, 2023 · 0 comments

Comments

@WilsonCazarre
Copy link

It would be beneficial for newcomers to the project to have a CONTRIBUTING.md project, describing some of the project guidelines.

From the top of my head, the file should have at least:

  • Libraries used in the project
  • Style guidelines used in code
  • Linter and other code quality tools that should be used.
  • Code architecture and folder structures
  • How to run automated tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@WilsonCazarre