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

Create documentation for contributors #67

Open
Dripcoding opened this issue Mar 23, 2022 · 1 comment
Open

Create documentation for contributors #67

Dripcoding opened this issue Mar 23, 2022 · 1 comment
Labels
Analysis documentation Improvements or additions to documentation HacktoberFest

Comments

@Dripcoding
Copy link
Contributor

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.

@preetkaran20
Copy link
Member

also integrate running of the unit test along with PR build in Github actions.

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

No branches or pull requests

2 participants