Skip to content

Create documentation for contributors #67

@Dripcoding

Description

@Dripcoding

Is your feature request related to a problem? Please describe.
Contributors should have documentation that will make it easier for them to contribute to the project.
This documentation should contain steps to:

  • install project locally
  • run tests and tools locally
  • open pull requests
  • install required tools like Docker
  • recommend best practices and link to resources for technologies used

Describe the solution you'd like
I'd like to see a Contributing.md that will act as a starting point for all contributors.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.
I've considered using a solution like docsifjs to create a documentation site. However I prefer to keep things simple at the start.

Additional context
Add any other context or screenshots about the feature request here.

Would you like to help fix this issue?
Just say if you'd like to try and help fix this issue. We'll provide any advice and guidance you need.

I'd like to help with this issue.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions