-
Notifications
You must be signed in to change notification settings - Fork 105
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
adding contributing guideline [skip ci] #259
Conversation
Hi @baentsch, thanks for following up here. The only hiccup I had in PR #188 was diagnosing CI failures, as CircleCI doesn't show failed test output (at least not to non-maintainers such as myself). Perhaps a sentence or two explaining how to run the tests locally would help newcomers diagnose their own issues before publishing a draft PR. Similarly, many projects I've seen have a DEVELOPMENT.md file explaining common workflows in the build/dev/test cycle. |
Thanks @WillChilds-Klein for the suggestions. Please check out the latest additions to the PR and let me know if/where you'd see obvious further room for improvement. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Excellent documentation, thank you @baentsch!
* adding contributing guideline * adding further dev support information Signed-off-by: Felipe Ventura <felipe.ventura@entrust.com>
* adding contributing guideline * adding further dev support information Signed-off-by: Felipe Ventura <felipe.ventura@entrust.com>
* adding contributing guideline * adding further dev support information
* adding contributing guideline * adding further dev support information Signed-off-by: Felipe Ventura <felipe.ventura@entrust.com>
* adding contributing guideline * adding further dev support information Signed-off-by: Felipe Ventura <felipe.ventura@entrust.com>
* adding contributing guideline * adding further dev support information Signed-off-by: Felipe Ventura <felipe.ventura@entrust.com>
Adding final item missing to complete https://github.com/open-quantum-safe/oqs-provider/community.
Feedback/suggestions for improvements particularly solicited from the most recent new contributors @thb-sb @marcbrevoort-cyberhive @WillChilds-Klein @alexzas: What information would help (have helped you :) most if documented?