Full Steps Pull Request
Thank you for considering to contribute to our seeed-studio files!
This streamlined contribution process, is to be able to offer full steps to PR the files. If you just want to add md file and images, you can check here.
Step by Step submit the files to repository
Prerequisite: git clone repo and deploy the websites locally
You can deploy the website locally and see the changes by clicking here!1. Bring your forked branch up to date
2. Update the downloaded files
Use the code below and update the downloaded files.
git checkout docusaurus-version
git pull
3. Modify the contents of existed files
All the files on the wiki platform are stored in the "docs" folder.
The name of file you want to change usually is the last part of the url(take Seeed Studio XIAO ESP32C3 as an example).
If you are going to add files
Store all added files(The markdown files and pictures) in the "Contributor_Files" folder:
4. Check the files changed locally
Once you done updating, you can use the command below to see whether it shows fine.
yarn start
On the edit platform:
On the local page:
5. Save and push the changes to your forked github repository
If all is ok, you can use the command below to push the changes to your forked github repository.
git add "the files that you changed"
git commit -m "Update：I have updated ..."
git push
5. Pull request to the Seeed Studio Repository
Once you have pushed the changes to your github repository, there is a column showing up automatically. Click the "Compare & Pull Request" button:
Show us what you have edited and click "creat pull request" button to us.
Thank you for your contributions!