Ivadomed: Improve Community Guidelines

Created on 7 Dec 2020  路  3Comments  路  Source: ivadomed/ivadomed

Currently, Community Guidelines are in:

It would be nice to also

  • have a file, eg CODE_OF_CONDUCT.md --> only point to the available resources
  • have issue and Pull-Request templates pointing to the relevant parts of the wiki
documentation

Most helpful comment

Assuming they did mean CONTRIBUTING.md, then we can do what SCT does.

  • Move the ./docs/source/contributing.rst file to ./CONTRIBUTING.rst (so that it is visible to reviewers).
  • Use a symlink for ./docs/source/contributing.rst that points to the base-level file.

That way, the information is visible in both locations.

All 3 comments

I wonder if the reviewers meant CONTRIBUTING.md instead of CODE_OF_CONDUCT.md. Because, CODE_OF_CONDUCT.md is more for... standards of behavior? Fostering a welcoming environment through kindness, respect, and handling conflict/discrimination/harassment. For example: https://github.com/tensorflow/tensorflow/blob/master/CODE_OF_CONDUCT.md

Code of conducts are lovely, but from context it seems like they meant contributing guidelines, so I'm not sure.

Assuming they did mean CONTRIBUTING.md, then we can do what SCT does.

  • Move the ./docs/source/contributing.rst file to ./CONTRIBUTING.rst (so that it is visible to reviewers).
  • Use a symlink for ./docs/source/contributing.rst that points to the base-level file.

That way, the information is visible in both locations.

Assuming they did mean CONTRIBUTING.md, then we can do what SCT does.

* Move the `./docs/source/contributing.rst` file to `./CONTRIBUTING.rst` (so that it is visible to reviewers).

* Use a symlink for `./docs/source/contributing.rst` that points to the base-level file.

That way, the information is visible in both locations.

Makes a lot of sense and sounds great! Thanks @joshuacwnewton for taking care of this

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jcohenadad picture jcohenadad  路  5Comments

andreanne-lemay picture andreanne-lemay  路  4Comments

mariehbourget picture mariehbourget  路  4Comments

olix86 picture olix86  路  3Comments

mariehbourget picture mariehbourget  路  3Comments