OpenGenus/vidsum

CONTRIBUTING.md - Instructions on how to contribute to Vidsum

lwgray opened this issue · 9 comments

lwgray commented

📝
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

Will be working on this @AdiChat

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

Thank You.

  • 👍1
AdiChat commented

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

waseem18 commented

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

  • 👍1
AdiChat commented

Sure 👍

  • 👍1
bhaveshAn commented

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

lwgray commented

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

lwgray commented

@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/
  • ❤️1
AdiChat commented

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

bhaveshAn commented

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

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

  • 👍1