Skip to content

Latest commit

 

History

History
85 lines (60 loc) · 4.79 KB

CONTRIBUTING.md

File metadata and controls

85 lines (60 loc) · 4.79 KB
Raw

Contribution Welcome

Thanks for your interest in contributing to this repository! Contributing to open source projects like this one can be a rewarding way to learn, teach, and build experience. Not only that, contributing is a great way to get involved with social coding.

If you are new to contributing to open source projects, the process can be intimidating. Not to worry! To help ensure both you and the community get the most out of your contributions, we've put together the following guidelines.

Request for contributions:

Please contribute to this repository if any of the following is true:

  • You have expertise in community development, communication, or education
  • You want open source communities to be more collaborative and inclusive

How to Contribute:

Prerequisites

In particular, this community seeks the following types of contributions:

  • Resources: Submit a pull request to add your content with links to related content.
  • Writing: Contribute your expertise in an area by helping us expand the included content.
  • Copy editing: Fix typos, clarify language, and generally improve the quality of the content.
  • Formatting: Help keep content easy to read with consistent formatting.

Steps to contribute:

  1. fork the project repository by clicking the fork button on GitHub. Fork
  2. clone your forked repository (noob tip: the actual command you type in is everything after the $):
   $ git clone https://github.com/<YOUR-USERNAME>/c-programs.git
  1. Add a new remote that points to the original project so you can sync project changes with your local copy:
 $ git remote add upstream https://github.com/Rohan-Shakya/c-programs.git
  1. Pull upstream changes into your local repositories development branch:
  $ git checkout development
  $ git pull upstream development && git push origin development
  1. Create a new branch from the development branch: branch

IMPORTANT: Make sure you are on the development branch first.

  $ git checkout -b <YOUR-NEW-BRANCH>

  1. Make your contribution to the project code.

  2. Write or adapt tests as needed.

  3. Add or change documentation as needed.

  4. After commiting changes, push your branch to your fork on Github, the remote origin:

    IMPORTANT: Your commit message should be in present tense and should describe what the commit, when applied, does to the code - not what you did to the code.

    $ git push -u origin <YOUR-NEW-BRANCH>

  5. From your forked GitHub repository, open a pull request in the branch containing your contributions. Target the project's development branch for the pull request.

  6. At this point, your contribution has been submitted for review. Please be patient while your contribution is being reviewed as this can take some time. Meanwhile, if there are questions or comments on your contribution, please respond and/or update with future commits.

  7. Once the pull request is approved and merged, you can pull the changes from upstream to your local repository and delete your extra branch(es).

Happy contributing!

Conduct

We are committed to providing a friendly, safe and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristic.

Please avoid using overtly sexual nicknames or other nicknames that might detract from a friendly, safe and welcoming environment for all.

Please be kind and courteous. There's no need to be mean or rude.

Respect that people have differences of opinion and that every design or implementation choice carries a trade-off and numerous costs.

Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works.

We will exclude you from interaction if you insult, demean or harass anyone.

Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome.

Communication

GitHub issues are the primary way for communicating about specific proposed changes to this project.