Skip to content

Latest commit

 

History

History
108 lines (66 loc) · 5.4 KB

Contribute by Forking.md

File metadata and controls

108 lines (66 loc) · 5.4 KB
Raw

How to Contribute

Before making any contributions, please ensure you have read our Code of Conduct and Contributing Guidelines.

Getting started guidelines

  • Take a look at the existing Issues or create a new issue!

  • Fork the Repo. Then, create a branch for any issue that you are working on. Finally, commit your work.

  • Create a Pull Request. This will be promptly reviewed and given suggestions for improvements by the community.

  • Add screenshots to your Pull Request when necessary to help us understand the effects of the changes proposed in your PR.

Making contributions via GitHub

You can make simple contribution like

  • Fixing grammar mistakes or typos
  • Editing or suggesting changes to the listed content
  • As well as contributing to the content and resources of the repo.
  • You can also ask a question or give an answer to an already asked question on the discussion page

This video explains how you can make a contribution right on GitHub.

How to make a Pull Request (PR)

This guide was a modification of the Microsoft 365 Platform Community Blog: How to contribute guide

  1. Install Visual Studio Code

  2. Create a Git (not GitHub) account

    • Open the terminal in Visual Studio Code
    • Type git --version in a directory of your choice - you should see the version of Git that you downloaded. If you see an error, close and reopen VS Code and try again.
    • Set your user name with git config --global user.name "<your-first-name> <your-last-name>" - replace the <placeholders> with the real values
    • Set your email address with git config --global user.email "<your-email-here>"- replace the <placeholder> with the real values (your email address should match the one with which you signed up for your GitHub account)

  3. Fork this repository to create a copy in your GitHub account:

  4. Clone the repository

Now you want to clone the repository so you have it locally available: fork repository

  • Select Code
  • Copy the URL (it is https://github.com/<YOUR GITHUB ACCOUNT>/blog.git)
  • Open the terminal in VS Code
  • Navigate to a directory where you want to clone the repository
  • Type git clone <COPIED URL HERE>
  1. Make chnages
  • in case you need some help on how markdown works, check out this website or learn how to write in markdown using these resources
  1. Commit and push your changes to your fork

Whenever you want to upload your changes to your remote fork:

  • type git add . (yes, there is a space ( ) between add and the .) - this adds all changes to staging area
  • type git commit -m "YOUR COMMIT MESSAGE" - this will commit your changes with the messages
  • type git push to push the changes to your remote fork
  1. Pull request

You will now want to (kindly) ask the repository maintainers to pull in your changes. You do that with a pull request:

PR Guides

  • Please give your PR a descriptive title
  • Commit messages should be meaningful and descriptive as possible.
  • Describe what's in the PR with
  • You can always switch to Preview to see how it looks like

A maintainer will review your pull request and merge your changes. Otherwise, it will be given constructive feedback and suggestions for the changes 🏆

This repository is maintained by volunteers in their free time, please be kind. Everyone is doing their best to keep things moving forward.

Congratulations! You've made your first contribution to Getting-started-in-Technical-Writing Repo 🙌🏼

Issues

In order to discuss changes, you are welcome to open an issue about what you would like to contribute or see in this repo.

want to ask a question?

Check out the dicussion page

Need to contact someone?

Please reach out to me on Twitter: Benny Ifeanyi

Please do give this repo a ⭐