Before making any contributions, please ensure you have read our Code of Conduct and Contributing 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.
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.
This guide was a modification of the Microsoft 365 Platform Community Blog: How to contribute guide
-
Install Visual Studio Code
-
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)
-
Fork this repository to create a copy in your GitHub account:
- Open Bennykillua/Getting-started-in-Technical-Writing (this repository)
- Select Fork
- Make a Fork --> The URL of your fork is now
https://github.com/<YOUR GITHUB ACCOUNT>/blog/
-
Clone the repository
Now you want to clone the repository so you have it locally available:
- 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>
- 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
- 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 (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
- Pull request
You will now want to (kindly) ask the repository maintainers to pull in your changes. You do that with a pull request:
- Open Bennykillua/Getting-started-in-Technical-Writing (this repository)
- Select Pull requests
- Select New pull request
- Select compare across forks
- Select your fork from the head repository
- Select Compare & pull request
- 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 🙌🏼
In order to discuss changes, you are welcome to open an issue about what you would like to contribute or see in this repo.
Check out the dicussion page
Please reach out to me on Twitter: Benny Ifeanyi
Please do give this repo a ⭐