Prepare "how to contribute" guide (Wiki) #302

Activity

1. taiya

   assigned

   taiya

   ,

   sofienbouaziz

   and

   julienvalentin

   on May 7, 2020
2. jackd commented on May 9, 2020

   

   jackd

   on May 9, 2020

   Contributor

   More actions

   Not specifically related to GSoC, but as someone who's keen to contribute whenever I find time:

   • is there a formal/informal RFC process for medium sized/larger works?
   • what is the expectation in terms of maintenance after a PR is accepted?
   • format specifications (yapf? command line args?)
3. taiya commented on May 9, 2020

   

   taiya

   on May 9, 2020

   Last edited by taiya

   CollaboratorAuthor

   More actions

   • Yes, for RFC communication happens via this github issues channel
   • Depends on what above I call "level of contribution"
     • core: you can help, but we are fully responsible
     • project: depending on how important it is we might maintain it, according to how useful it is. (e.g. PointNet is ubiquitous, so the fact that its training pipeline is well oiled is important, other contributions might be less fundamental)
     • submodules: currently there are zero requirements, but I expect a dry-run coverage test will be asked at last, and if that test fails for too long – author's repo not maintained – we can drop the dependency. We have not setup this yet though.
   • We are using Google standard python format. I have not setup yapf-like automated systems yet, but would be great to add that in (will likely happen soon'ish)

   👍React with 👍1Reacted by Dominic Jack
4. julienvalentin commented on May 14, 2020

   

   julienvalentin

   on May 14, 2020

   Contributor

   More actions

   this looks good to me Andrea

   👍React with 👍1Reacted by Andrea Tagliasacchi
5. taiya

   added

   WIPWork In ProgressWork In Progress

   on May 23, 2020
6. taiya commented on May 23, 2020

   

   taiya

   on May 23, 2020

   CollaboratorAuthor

   More actions

   @julienvalentin, PTAL

   • https://github.com/tensorflow/graphics/wiki/Home
   • https://github.com/tensorflow/graphics/wiki/pull_request
7. taiya commented on May 23, 2020

   

   taiya

   on May 23, 2020

   CollaboratorAuthor

   More actions

   @sofienbouaziz julien removed TravisCI, but the Build workflow does not check for coverage. You might want to add it back, and add the corresponding docs to this page?
8. taiya

   pinned this issue on May 23, 2020
9. Molkree commented on Jun 5, 2020

   

   Molkree

   on Jun 5, 2020

   Last edited by Molkree

   Contributor

   More actions

   Hi, @ataiya!
   You might want to add the section about notebooks too. TensorFlow Docs team has notebook formatter. Just a link to existing Docs guidelines and a mention that failing formatting check will prevent PR from merging (just like linting and tests) would probably be enough.
   I can format existing notebooks and add formatter test to the workflow (in fact I've already done half of it here so if you are interested, let me know!)
10. taiya commented on Jun 5, 2020

    

    taiya

    on Jun 5, 2020

    CollaboratorAuthor

    More actions

    That's an interesting idea, but I let @julienvalentin comment here.
    I do not use notebooks, nor will I ever :)