Cosmos: Update our Contributing Guidelines so that they are actually contributing guidelines!

Created on 23 Feb 2018  路  6Comments  路  Source: OpenGenus/cosmos

This is a(n):

  • [ ] New algorithm
  • [ ] Update to an existing algorithm
  • [ ] Error
  • [x] Proposal to the Repository

Details:

  • Right now, our contributing page contains a list of our contributors. While this is fine, it doesn't contain what it is supposed to: contributing guidelines!
  • This can be confusing for new users who navigate to this link from the pull request/issue creation link.
  • I propose that someone adds a section to the contributing guidelines, right before the contributors' list, that lists our contributing guidelines.

Shoutout to @SnehaR26 for finding this issue in #3250!

Any of our new (or old) contributors can take this issue on, please add a comment if you want to do so and reference this issue in your PR.

Most helpful comment

Basically the style guide should tell what the user needs to do before contributing, which is

  1. Look at the style guides for your language
  2. Follow the code of conduct
  3. Make sure the algorithm is not already implemented

Obviously, more detail is needed, but this is what I came up with at my first thought. So yes, it is an "amalgamation" of the two things you said. 馃槅

If you need more, you can always ask @AdiChat for more guidelines. (I have pinged him)

All 6 comments

Can I take up this issue?

May I also suggest that we create a new file for contributing guidelines and leave the file for contributors unchanged.

@SnehaR26 Yes you can take this up. Making a separate file is also a good idea, except that you should change the name of the file CONTRIBUTING.md to CONTRIBUTORS.md. Call the new file CONTRIBUTING.md.

- Thanks!

Sure!
Is contributing guidelines an amalgamation of code of conduct and style guides for various languages?

Basically the style guide should tell what the user needs to do before contributing, which is

  1. Look at the style guides for your language
  2. Follow the code of conduct
  3. Make sure the algorithm is not already implemented

Obviously, more detail is needed, but this is what I came up with at my first thought. So yes, it is an "amalgamation" of the two things you said. 馃槅

If you need more, you can always ask @AdiChat for more guidelines. (I have pinged him)

@arnavb may I also work on this issue ?

@vandana1212 Well, since @SnehaR26 has already taken up the issue, there really is nothing you can do that I know of. (This is a pretty minor change). I would ask Sneha if there really is anything you can do. 馃憤

Was this page helpful?
0 / 5 - 0 ratings

Related issues

CaramelHeaven picture CaramelHeaven  路  3Comments

arnavb picture arnavb  路  3Comments

qoo2p5 picture qoo2p5  路  4Comments

arnavb picture arnavb  路  3Comments

sebasrp picture sebasrp  路  3Comments