gasparl / citapp_pc

CITapp: a response time-based Concealed Information Test lie detector web application. This method aims to reveal whether or not a certain information detail (e.g. a photo taken from the scene of a recent burglary) is known to the tested person.
https://gasparl.github.io/citapp_pc/CITapp.html
BSD 2-Clause "Simplified" License
1 stars 3 forks source link

6. Instructions for contribution and getting support #6

Closed vsoch closed 5 years ago

vsoch commented 5 years ago

In the future, it could be that someone wants to contribute to your code! The repository is missing instructions in the README.md to do this, and it's also commonly seen to have a .github folder with a CONTRIBUTING.md file. You can even find templates if you do a Google search. The example that I linked also includes a Code of Conduct, and this is also important to add. You can also add it as another file in .github, CODE_OF_CONDUCT.md. You always want to have a standard for interaction in the case that someone is behaving inappropriately in an issue or PR (it happens, if you can't believe it!)

It's also likely that someone will want to ask you a question or get help. For this, you can just have a section in the readme (Support) and then link them to your issues board here.

Review: https://github.com/openjournals/joss-reviews/issues/1179

gasparl commented 5 years ago

Yes, I missed this, again thanks for noting. I now added the CONTRIBUTING.md file (with a short Code of Conduct inside it).

I also added the Support section in the README.

vsoch commented 5 years ago

Perfect!