Skip to content

contribute

Aditya Chatterjee edited this page Mar 10, 2018 · 12 revisions

Contribution guidelines :sparkles:

The contribution structure at Cosmos has been kept as simple as possible. 😄

If you have made a contribution, congratulations :tada: You need to follow these steps to get it merged (it is easy):

  • Get in touch with other members to review your contribution.
  • Get at least 2 approved reviews of which at least one should be from a Maintainer.
  • Work over the suggestions given by others and update your pull request.
  • Your pull request will be merged. :gift: Congratulations on becoming an integral part of OpenGenus :heart_eyes:

:thinking: What's next?: Go on to make your next contribution and continue enjoying and learning!

As you continue your journey :steam_locomotive: in making Cosmos better, you will enjoy additional rights.

Read on to find out how to make a great contribution:

Note: Before you start working on an issue, kindly state what you are doing specifically in the concerned issue or create a new issue. If multiple users end up making the pull request for the same task, the person who informed everyone in the issue first will be given preference.

You can create your own issue to add a content which you do not see in the current code base 🎉 Kindly browse through the code base to ensure that what you intend to implement does not exist already.

Naming convention: folders and filenames should be in lowercase and each word separated by _. Names should be descriptive to certain extend. 👍

Every code contribution may contain the following comment as a part of it:

/* Part of Cosmos by OpenGenus Foundation */

There are 3 basic types of contribution:

  • Add code for a particular category

In this contribution type, one submits a pull request consisting of a code in a particular language. We accept every language as in our community, we will always find someone who used even the most esoteric or unknown language. To name a few language, you must try to add a contribution in C, C++, Java, Python, Go, JavaScript, C#, Swift, F# and many others.

For instance, this code Binary search in Java is in this category.

  • Add a test file for a particular code in a category

In this contribution type, one submits a pull request consisting of a test file for an existing code in a particular language. We accept every language as in our community, we will always find someone who used even the most esoteric or unknown language. To name a few language, you must try to add a contribution in C, C++, Java, Python, Go, JavaScript, C#, Swift, F# and many others.

  • Add a code category

In this contribution, one create a code category which will hold codes solving the problem at hand in various languages.

For instance, this category binary search is in this category.

  • Add an explanation for code category

In this contribution, one must provide an explanation to a code category in markdown format under the code category folder. This is very important contribution in making the learning experience better.

Take a look at this wonderful documentation template


All pull requests are reviewed by maintainers and we are ready to help if you get stuck. Join us at Slack and let us know.


Category Readme Template

<category_name>

<description>

<footer>

The format of the footer should be:


A massive collaborative effort by OpenGenus Foundation


You can’t perform that action at this time.