As this project is a part of an Open Source Program NJACK Winter of Code I would recommend to have a contribution guidelines file (CONTRIBUTING.md) to assist beginners to get started with open source contribution.
Points to be covered in the guideline :
How to pull your first request.
How to create issue.
Some general rules to keep in mind while contributing to an open source project.
Links of some tutorials which will help beginners to learn the basics of git and github.
Add
CONTRIBUTING.md
FileAs this project is a part of an Open Source Program
NJACK Winter of Code
I would recommend to have a contribution guidelines file (CONTRIBUTING.md
) to assist beginners to get started with open source contribution.Points to be covered in the guideline :