GitHub Wiki Contribution
Opened this issue · 3 comments
Description:
I have made some improvements and updates to my DGBNOOB/digibyte/wiki forked repository and would like to contribute these changes to DigiByte-Core/digibyte/wiki.
I used Copilot to walk me through all the steps because the current wiki contribution guidelines aren’t applicable. I figured out that when you fork the main repository, the wiki doesn’t carry over because it’s a separate storing location. The current Contribution Workflow and Git Contribution Guideline don’t pertain to contributions to a repository's wiki.
I updated the repository link to navigate to the main repository DigiByte-Core/digibyte to go with the contribution workflow and cloning the repository instructions.
I updated the Wiki Platform section to reflect GitHub Flavored Markdown. I added a note that the repository and wiki are maintained in two separate places and modified the "clone your fork" line. I also modified "clone your repository" to "clone wiki locally" with steps on how to do that.
Since the Contribution Guidelines reference the Markdown user guide for Node.js, I converted the Guidelines to GitHub Flavored Markdown and referenced GitHub docs and Basic Writing and Formatting Syntax.
I updated the Markdown User Guide:
I added to the Terminology page. Under Protocol Implementations, there was only information about DigiShield and MultiAlgo. I added information about MultiShield, DigiSpeed, SegWit, Digi-ID, DigiAssets, Dandelion++, and Odocrypt.
I included the links to each wiki page so that the maintainers can provide feedback and merge them into the main repository if they find them valuable.
Steps Taken:
Forked the original DigiByte wiki repository.
Made necessary changes and updates in my cloned repository.
Committed and pushed the changes to my forked repository.
Link to Forked Wiki Repository:
You can review my changes here: https://github.com/DGBNOOB/digibyte/wiki
Request:
Please review the changes in my forked repository. If you find them valuable, kindly merge them into the main DigiByte-Core/digibyte/wiki. Thank you!
If there are any questions or further modifications needed, please let me know.
Thank you for taking the time to do this! Looks like a great start to me. Would you mind opening this as a pull request against the repo with all the changes? Much easier to review that way.
Or was there an issue trying to do that specifically with the wiki? I have never tried opening a PR against the wiki before.
Thank you for responding.
I am new to this, however, I am willing to learn. From what I have gathered, the main repository and the wiki are stored in two separate locations.
When I forked DigiByte-Core/digibyte, the wiki files didn't carry over to my remote repository. I followed all the steps to clone DigiByte-Core/digibyte/wiki locally, made the changes, and pushed them back to my remote wiki. When I go to create a pull request, there isn't an option to pull request the wiki. I tried following the Contribution Guidelines-Workflow and Git Contribution Guide, but they don't pertain to a GitHub wiki. Once I figure out the steps, I will update them as well. For now, I'm going back and forth between Copilot and GitHub, trying to figure out how this specific process works.
I'll continue to try to figure out how to create a pull request for the wiki. If anyone with experience contributing to the wiki could help, that would be helpful.
-Jose
From what I know it is, as Jose say, not possible to make PR towards wiki. Repo maintainers are the only ones who can make changes to wiki.
Since it is MD it would be a mere copy paste job.