Improve the README.md #28
Conversation
|
Thank you for adding these docs, @afrittoli! 🎉 |
Good point :) Thanks for the review! |
contributing.md
Outdated
|
|
||
| Thank you for contributing your time and expertise to CDEvents. This document describes the contribution guidelines for the project. | ||
|
|
||
| **Note:** Before you start contributing, you must read and abide by our **[Code of Conduct](./code-of-conduct.md)**. |
There was a problem hiding this comment.
Just realized that both the contributing and code of conduct probably should be in the .github repo. See https://github.com/eiffel-community/.github for an example
There was a problem hiding this comment.
Yeah, we could add them there.
The code of conduct shows up here:
and the contributing can be see in the "issues" and "PR" pages as a first time contributor:
The files do not show up in the repos though which is not super-nice. I though they used to? 🤔
Links to them need to be cross repo to the .github repo, and those files cannot point to repo specific files either, like a repo specific DEVELOPMENT.md or so.
Would it be an overkill to keep the files in both places?
There was a problem hiding this comment.
I would start with having it in the .github repo and then if needed we can think about duplicating them.
|
|
||
| CDEvents is developing as set of SDKs: | ||
|
|
||
| * [Go](https://github.com/cdevents/sdk-go) |
There was a problem hiding this comment.
@erkist Do you want Python to be listed here also?
Add a link to CONTRIBUTING.md and improve the README.md to include links to the various documents. Remove the code of conduct that is now hosted in the .github repo. Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
afrittoli
force-pushed
the
contributing
branch
from
0100159 to
df67a1e
Compare
afrittoli
changed the title
Add a link to CONTRIBUTING.md and improve the README.md to include links to
the various documents.
Remove the code of conduct that is now hosted in the .github repo.
Signed-off-by: Andrea Frittoli andrea.frittoli@gmail.com