Skip to content

Latest commit

 

History

History
60 lines (33 loc) · 3.73 KB

Contributing.md

File metadata and controls

60 lines (33 loc) · 3.73 KB

Contributing to Contributors-shield

First of all,thanks for your willingness shown to contribute !!

Following is a set of basic guidelines for contributing open source projects hosted by vildantursic onGitHub.

Ways to Contribute

Need to contribute ? Have passion in Coding ? Then you can always free to make PRs for issues. But make sure that you are the only person who is working on the same issue.

If you are out of ideas,still you can contribute.Reporing Bugs, Documentation , Suggesting Improvements etc. are few of contributions for you except PRs.

Reporting New Issues - Bugs

This section guides how to make a Bug report which can be understand by the community and enables to reproduce the behaviour.

GitHub tracked Bugs as Issues.Firstly follow the GitHub Issues to get a overrall idea on GitHub Issues.After you understood what is going on,then create a new Issue on the particular repository and provide necessary Information.

Please follow below instructions to submit a good Bug Report

  • Always Use a Clear and Descriptive Title - This helps contributors to identify the problem quickly
  • Describe the steps which leads to the certain Issue - Better if describe the steps in brief.
  • Provide Screenshots and if can GIFs - Though is an additional , it makes the contributors to understand the problem clearly.
  • Describe the behavior you observed after following the steps - Mention the exact problem corresponding to the step.
  • Explain which behaviour you are expected to see and Why so ? - This guides what to fix with the issue.

Documentation

This section guides how to contribute projects by Documentation. Documentation consists of Contributing.md,Code_Of_Conduct.md etc.Follow below instructions before create Documents for the project.

  • Follow GitHub CODE_OF_CONDUCT before contributing.
  • Make sure to select correct Licence before adding - If have any problems don't hesitate to contact via mail lists of organization. Follow Licensing a repository for a better understanding.

Template of Good_Contributing.md check for further understanding.

Suggesting Improvements

Improvements also same as GitHub Issues.

GitHub tracked Improvements as Issues.Firstly follow the GitHub Issues to get a overrall idea on GitHub Issues.After you understood what is going on,then create a new Issue on the particular repository and provide necessary Information.

  • Always Use a Clear and Descriptive Title - This helps contributors to identify the Improvement quickly
  • Describe the steps which leads to the certain Improvements - Better if describe the steps in brief.
  • Explain current behaviour if the minor version already implemented and Explain what you expect instead

Lets begin to Contribute

  • Firstly Fork the repository to your GitHub account.You can easily do it by clicking the Fork button placed at the top right coner of the repository page.Then Clone it into local PC by clicking the Clone or Download button.It is better to use GitHub Desktop if you are a beginner to GitHub.

  • Then you can create a new branch on the cloned repository.You can do it using the web interface or with an IDE in your PC.

  • Now you can begin to contribute. Developed codes,documents should be pushed to the branch you have created and commit on it.

  • And Make sure to pull the repository each time before push your contributions to the repositortes.

Now you are ready to contribute...Cheers!!!