search

OpenGenus / vidsum

Generate summary of any video :tv: anywhere and anytime
GNU General Public License v3.0
261 stars 69 forks source link

CONTRIBUTING.md - Instructions on how to contribute to Vidsum #14

Open lwgray opened 7 years ago

lwgray commented 7 years ago

:memo: To help contributors get more easily started, I think there should be a contributing.md file. It would be a general guide on how to contribute to Vidsum.

This file could contain information on:

  1. Code of Conduct
  2. Style guide (ie PEP8)
  3. Info on committing & pull requests

Here is an example template of a CONTRIBUTING.md file

Implementing this would address issue #13

waseem18 commented 7 years ago

Will be working on this @AdiChat

Let me know if there's anything more you want me to know about this.

Thank You.

AdiChat commented 7 years ago

I am designing a contributors page on the Wiki. Take a look and make contributions there.

waseem18 commented 7 years ago

@AdiChat Going out for an hour for something important. Will then start drafting it

AdiChat commented 7 years ago

Sure 👍

bhaveshAn commented 7 years ago

@AdiChat please let me know. why this issue is not closed even after #29

lwgray commented 7 years ago

@bhaveshAn The contributing.md file should contain more information that provided in your PR #29 See above info...

lwgray commented 7 years ago

@AdiChat Do you think we could add a code of conduct for this repository.. Here are some examples that are open source. Could we adopt one?

  1. https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md
  2. https://www.djangoproject.com/conduct/
  3. http://citizencodeofconduct.org/
AdiChat commented 7 years ago

Yes. We should adopt one 👍 Which one do you suggest?

bhaveshAn commented 7 years ago

https://www.djangoproject.com/conduct/ http://citizencodeofconduct.org/

@AdiChat I think these both are good. Whichever to follow.