vidsum icon indicating copy to clipboard operation
vidsum copied to clipboard

CONTRIBUTING.md - Instructions on how to contribute to Vidsum

Open lwgray opened this issue 6 years ago • 9 comments

: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

lwgray avatar Oct 01 '17 12:10 lwgray

Will be working on this @AdiChat

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

Thank You.

waseem18 avatar Oct 01 '17 12:10 waseem18

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

AdiChat avatar Oct 01 '17 12:10 AdiChat

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

waseem18 avatar Oct 01 '17 12:10 waseem18

Sure 👍

AdiChat avatar Oct 01 '17 12:10 AdiChat

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

bhaveshAn avatar Oct 04 '17 13:10 bhaveshAn

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

lwgray avatar Oct 05 '17 20:10 lwgray

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

lwgray avatar Oct 05 '17 21:10 lwgray

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

AdiChat avatar Oct 05 '17 21:10 AdiChat

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

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

bhaveshAn avatar Oct 05 '17 22:10 bhaveshAn