Skip to content
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

Add CONTRIBUTING.md #2651

Closed
2 of 3 tasks
vfdev-5 opened this issue Sep 8, 2020 · 7 comments
Closed
2 of 3 tasks

Add CONTRIBUTING.md #2651

vfdev-5 opened this issue Sep 8, 2020 · 7 comments
Assignees

Comments

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Sep 8, 2020

🚀 Feature

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

TODO:

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

cc @fmassa

@oke-aditya
Copy link
Contributor

oke-aditya commented Sep 8, 2020

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.

@fmassa
Copy link
Member

fmassa commented Sep 9, 2020

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.

@vfdev-5 vfdev-5 self-assigned this Sep 9, 2020
@cpuhrsch
Copy link
Contributor

cpuhrsch commented Sep 10, 2020

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

@vfdev-5
Copy link
Collaborator Author

vfdev-5 commented Dec 4, 2020

TODO for this issue:

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

@datumbox
Copy link
Contributor

datumbox commented Dec 4, 2020

@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.

@vfdev-5
Copy link
Collaborator Author

vfdev-5 commented Dec 4, 2020

Thanks, I agree !

@vfdev-5
Copy link
Collaborator Author

vfdev-5 commented Feb 7, 2022

Let's close this issue and if needed open a specific one for new dataset addition

@vfdev-5 vfdev-5 closed this as completed Feb 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants