Add CONTRIBUTING.md - Githubissues

350org / strikes-poster-generator

A mini web app that lets anyone create a printable poster or flyer with their own custom text.

BSD 3-Clause "New" or "Revised" License

7 stars 5 forks source link

Add CONTRIBUTING.md #5

Open dtoakley opened 5 years ago

dtoakley commented 5 years ago

As a developer I want a CONTRIBUTING.md to be added so I know how to contribute to the project.

it should include:

How to run locally
How to run any tests
Any code style specifications
How to run linting (if we have it)
How to build
How to deploy

jamescrowley commented 5 years ago

@dtoakley some of those points are already covered in the readme, and I suspect makes more sense there - running locally, tests, build & deploy I think you'd want to know even if you're not contributing. Thoughts?

Code style & listing perhaps fits more in contributing. I could write something off another project I'm on - https://github.com/boxwise/dropapp/blob/master/CONTRIBUTING.md if that's helpful?