Skip to content

A tailor-made contribution guide #802

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.

Sign up for GitHub

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

Jump to bottom
Closed
poyea opened this issue May 12, 2019 · 2 comments · Fixed by #864
Closed

A tailor-made contribution guide #802

poyea opened this issue May 12, 2019 · 2 comments · Fixed by #864
Assignees
@poyea

Comments

@poyea
Copy link
Member

poyea commented May 12, 2019 •
edited
Loading

I think we should write a Contribution Guide from which:

  1. New comers know how they can contribute
  2. Everyone know what do the community, especially users and readers expect
  3. Most importantly, everyone learns about the standard of code contribution, like do we need testing in submission? Is it a strict requirement? Do we need comment description? Are one-liners acceptable? How to deal with "one-liner" alternatives?

I found #432 and #433 relating to this, but the commit concerned is not quite tailor-made to us and thus reading it will not help a newcomer to know points 2 and 3.
@AnupKumarPanwar
Copy link
Member

@poyea I agree with you. I think we should cover the contribution standards in the README.md file. Check the README file of Algorithms-Explaination for reference.

@poyea poyea self-assigned this May 27, 2019
@minddetox
Copy link

This would be helpful. i’m so eager to learn and not sure where to begin. thank you

@poyea poyea mentioned this issue Jun 1, 2019
Merged
poyea added a commit that referenced this issue Jun 1, 2019
@poyea
Create CONTRIBUTING.md
a58a64f 
* Create a tailor-made contribution guide

Closes #802
yanglbme pushed a commit that referenced this issue Jun 2, 2019
@poyea @yanglbme
Create CONTRIBUTING.md (#864)
c2552cd 
* Create CONTRIBUTING.md

* Create a tailor-made contribution guide

Closes #802

* Update README.md

* Rename License to LICENSE.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@poyea poyea

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Create CONTRIBUTING.md TheAlgorithms/Python
3 participants
@AnupKumarPanwar @poyea @minddetox