Vision: Add CONTRIBUTING.md

Created on 8 Sep 2020  路  6Comments  路  Source: pytorch/vision

馃殌 Feature

It is a good practice to have CONTRIBUTING.md file to describe some guidelines for open-source contributions.

TODO:

  • [x] Version 1
  • [ ] complete section about how to add a new model
  • [ ] complete section about how to add a new dataset

cc @fmassa

documentation

Most helpful comment

We could also reference the pytorch contribution guidelines with some additional torchvision specific guidance.

All 6 comments

Yes ! I was about to raise this Issue. Something in lines of ignite contribution file would be nice.

Most might struggle to build docs, format code with linting etc.

Yes, that is a great thing to have.

I think we should clarify what are the criteria for adding new models / layers to torchvision, so that it's clear from the beginning.

@vfdev-5 if you could start with a first, more generic, draft of the CONTRIBUTING file we could iterate on it

Tagging @cpuhrsch @dongreenberg for thoughts.

We could also reference the pytorch contribution guidelines with some additional torchvision specific guidance.

TODO for this issue:

  • [ ] complete section about how to add a new model
  • [ ] complete section about how to add a new dataset

@vfdev-5 Just a suggestion. Perhaps add in the list that the CONTRIBUTING.md v1 was added and there are 2 more pendings. I would also put this on the top of the ticket instead of the comments so that it's visible and it's tracked by Github checklists.

Thanks, I agree !

Was this page helpful?
0 / 5 - 0 ratings

Related issues

iacolippo picture iacolippo  路  4Comments

xuanqing94 picture xuanqing94  路  3Comments

martinarjovsky picture martinarjovsky  路  4Comments

IssamLaradji picture IssamLaradji  路  3Comments

chinglamchoi picture chinglamchoi  路  3Comments