Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
typos fixed:
line 9- repository ,
line 11- documention
line 16- Github, straight forward
line 22- in(removed)
line 24- asking, will, are any problems
line 28- meaningfully rephrased(without changing structure and context)
  • Loading branch information
mangnez authored Sep 29, 2023
1 parent 1fc722f commit 1679aa3
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,23 @@ First of all, thank you for taking the time to contribute to this project. We've
### Check out the projects folder

We have some awesome projects available on the repository.
If you would like to contribute some more projects which is not there in this repository , feel free to contribute.
If you would like to contribute some more projects which is not there in this repository, feel free to contribute.
If you found a bug please open an issue.
We are looking for better documention and optimization of code.
We are looking for better documentation and optimization of code.


### Writing some code!

Contributing to a project on Github is pretty straight forward. If this is your first time, these are the steps you should take.
Contributing to a project on GitHub is pretty straightforward. If this is your first time, these are the steps you should take.

- Fork this repo.

And that's it! Read the code available and change the part you don't like! Your change should not break the existing code.

If you're adding a new functionality, start from the branch **main**. It would be a better practice to create a new branch and work in there.
If you're adding a new functionality, start from the branch **main**. It would be a better practice to create a new branch and work there.

When you're done, submit a pull request and for one of the maintainers to check it out. We would let you know if there is any problem or any changes that should be considered.
When you're done, submit a pull request asking for one of the maintainers to check it out. We will let you know if there are any problems or changes that should be considered.

### Documentation

Every chunk of code that may be hard to understand has some comments above it. If you write some new code or change some part of the existing code in a way that it would not be functional without changing it's usages, it needs to be documented.
Any piece of code that might be challenging to understand is accompanied by comments. If you add new code or modify existing code in a way that affects its functionality or requires changes in its usage, you must document these changes.

0 comments on commit 1679aa3

Please sign in to comment.