Skip to content

Latest commit

 

History

History
41 lines (25 loc) · 3.45 KB

Contributing.md

File metadata and controls

41 lines (25 loc) · 3.45 KB

Random Text Generator with Brython

GitHub custom open for collaboration

This repository is open for all contributions. Any kind of updations, additions, modifications and any other form of contribution is welcome. In case you're new to open source and contributing, be sure to read about GitHub, GitHub Guide, GitHub Open Source, and you are encouraged to check OpenSource.Guide.

Alongside, please feel free to open new issues and pull requests.

Every contribution counts, and will go a long way towards betterment of the code and/or its related files.

Essential steps to get contributing

To be able to contribute to this repository with GitHub Flow, be sure to fork this repository from the fork option at the top-right of this repository, if not yet done. Your forked repository is from where you'll initiate (and later update, if needed) your pull requests from.

Go to your forked repository to add and update files for improvisation. Now, you can do this either directly from GitHub Website, or by using GitHub CLI (Command Line Interface).

After cloning the repository, please read and understand what the existing code or document is meant for, before overwriting it with your changes. If you're unsure about any part, feel free to ask it in discussions, and we'd be happy to help.

Here's a summary of essential steps when using CLI, just to keep you in flow, and to ensure that you don't miss on any of the necessary steps:

  1. Star (Optional, will help you in staying up-to-date with the base repository) and Fork this repository.
  2. git clone <Your_Forked_Repo_URL_Here> (This will download and save a folder for your existing repository, locally in your machine.)
  3. Check existing files, and make your desired updations.
  4. git checkout -b <newBranch> (Optional step, but helpful in case where multiple active pull requests are expected)
  5. git add . or git add -A (This adds all the files for tracking and including in the next commit)
  6. git commit -m "<Your One-Liner Commit Message>" (This commits your changes locally)
  7. git pull or git pull --set-upstream origin <branchName> (This pulls any further changes from the server and ensures that the local repository is again up-to-date with the host repository)
  8. git push or git push origin <branchName> (This pushes your changes to the repository)

After following these steps in Git CLI (in order), you'll need to go to your GitHub repository in the website to initiate a new Pull Request.

Assistance to get started (for beginners)

If you're new to contributing and have no idea about working with repositories, be sure to check and start here. Quickstart docs from GitHub may also be helpful in this case.

So, what are you waiting for? Begin contributing now!

Every commit matters! 🚀☺