Skip to content

Commit

Permalink
Updated Contributing.md for minor typos and errors
Browse files Browse the repository at this point in the history
Signed-off-by: Lalit Umbarkar <[email protected]>
  • Loading branch information
MrL1605 committed Oct 2, 2019
1 parent b1c5018 commit dc3effe
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,46 +25,48 @@ and ask that you try to as well:
- There are worse things than being explicit...

We have created some issues in every project as a starting point for Beginners.
There are two major types of contribution:
There are two types of contribution:
- Work on Existing Issues.
- Create a new Issue and submit its changes related to it.

### Working on Existing Issues

Check out the [issues](https://github.com/vardhanapoorv/Open-Source-Contribution-Made-Easy/issues)
page and pick a issue you are interested in and add a comment mentioning the changes.
As this repository is for beginners, we do not have any restrictions on how the specifics
of implementation on how are fixing it, but we would want you to mention what are the
changes you are proposing. Any proposal you made you be accepted anyway (unless there is
a conflict with someone else's contribution).

There are some issues with tag `minimal-work`, these issues are meant for those who are
first timers, as there is no scope for making mistakes in this. Make sure that you do not
create PRs with just `minimal-work` issues. We recommend that you have other issues that
do not have `minimal-work` tag with the same PR.
page and pick a issue you are interested in and add a comment mentioning the
changes. As this repository is for beginners, we do not have any restrictions
on how the specifics of implementation on how are fixing it, but we would
want you to mention what are the changes you are proposing. Any proposal you
made you be accepted regardless (unless there is a conflict with someone
else's contribution), so you can start working without waiting for our approval.

There are some issues with tag `minimal-work`, these issues are meant for
those who are first timers, as there is no scope for making mistakes in
this. Make sure that you do not create PRs with just `minimal-work` issues.
We recommend that you have other issues that do not have `minimal-work`
tag with the same PR.

### Creating new Issue

A [new issue](https://github.com/vardhanapoorv/Open-Source-Contribution-Made-Easy/issues/new)
could e created if you think more improvement could be done in existing application OR
we are also open to new ideas for projects/languages to be included in this repository.
We could discuss how it would make others contributing easier.
could be created if you think more improvement could be done in existing
application OR we are also open to new ideas for projects/languages to
be included in this repository. We could discuss how it would make
others contributing easier.

# Contributing changes

If you _are_ interested in contributing changes to `Open-Source-Contribution-Made-Easy`,
please first select a issue or create a issue that you want to work on and
comment in it mentioning that you have these proposed changes, then fork this
repository, make a new branch in your fork, commit your changes to that branch
and then make a pull request from that branch. Mention the issue As part of
and then make a pull request from that branch. Mention the issue as part of
your pull request, make sure that you add yourself to the
[Contributors list](https://github.com/vardhanapoorv/Open-Source-Contribution-Made-Easy/issues/10).

## Writing code

As we have multiple languages in this repository, when writing your code, try
to follow existing code style as much as possible -
in particular, this means:
to follow existing code style as much as possible - in general, this means:

- Wrap code (mostly) to 80 columns (type annotations and string literals can
be longer if you want).
Expand All @@ -73,13 +75,13 @@ in particular, this means:

Don't worry too much about writing documentation - small fixes for things like
typos and formatting are certainly welcome. In a major project repo documentation
if important but you will get used to writing docs by contributing.
is important but you will get used to it by contributing.

## Testing

In any other project, this would be of major importance for maintainers, as it
is easier for them to verify changes. But we have kept this as optional in this
repository. If tests are exist for a given project, make sure that they pass
repository. If tests already exist for a given project, make sure that they pass
before creating PR. If they don't exist and you want to create tests for it,
create a new issue, explain your tests and create the PR. We would be happy to
help.
Expand Down

0 comments on commit dc3effe

Please sign in to comment.