👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The goal of the open-source AFWERX Guides project is for members of the community to contribute and improve the guides.
The project is beginner-friendly and we hope many people are able to make their first open-source contribution through this project.
You can help improve the guides in three ways:
You need a Github account to contribute, but you can do everything entirely through your web browser.
Bugs (errors) are tracked as GitHub issues. First, check the existing issues to see if someone has already reported the problem. If they have and the issue is still open, add a comment to the existing issue instead of opening a new one.
If there isn’t an existing issue, create a new issue. Explain the problem and include additional details to help maintainers of the project fix it.
If you see a way to improve a guide (e.g. fix typo or add a paragraph/link), you can submit a pull request which will tell the maintainers of the project you have a suggested improvement.
Each page in the site has a
pull request link in the footer or sidebar which will start the process of creating a pull request from a fork to edit that page of the website.
Once you submit the pull request, the maintainers will review, edit (if needed), and then push the change to the website.
If you would like to develop a new guide, first submit your suggestion as a new issue. The project maintainers will provide additional guidance.
Don’t worry if you aren’t familiar with Markdown, you can write your guide using Google Docs and convert it to Markdown, see below.
Here are the steps to create a new guide:
- Write the guide in Google Docs
- You must use appropriate heading styles for the conversion software to work properly, e.g. in the Google Docs menu: Format -> Paragraph Styles -> Heading 1
- Convert your Google Docs text to Markdown using a Google Docs add-on called Docs to Markdown.
- Create a new file in the appropriate docs folder on Github. Name the file and add the
.mdfile extension for Markdown.
- Paste your Markdown text into the new file.
previewat the top of the GitHub editing window to see what your markdown will look like on the web. Make edits as needed.
- OPTIONAL: Add Jekyll front matter to the top of the guide for title and navigation. The project maintainers will add this if you’re not sure. For example:
--- layout: default title: My New Guide parent: Spark Cell 101 nav_order: 4 --- # My New Guide This is how to...
- Submit change as a pull request. Click the big green
propose new filebutton, review changes, then click the green
create pull requestbutton.