Skip to content

Contribution Guidelines

Jump to bottom
Jose Trejo edited this page Dec 4, 2024 · 7 revisions
Title Contribution Guidelines
Description Guide to contribute to the DigiByte Wiki
Published true
Date 2023-10-22T11:38:22.657Z
Tags
Editor markdown
DateCreated 2023-10-22T09:24:43.645Z

Contribution Guidelines

Thank you for considering contributing to the DigiByte Blockchain Community Wiki. This guide outlines the process and guidelines for contributing to our wiki, ensuring that your contributions are valuable, well-structured, and easy for the community to understand.

Where to Contribute

We accept contributions exclusively through GitHub, using Pull Requests (PRs) made to the Develop branch of our repository. You can find our GitHub repository here: DigiByte-Core/digibyte.

Preferred Syntax for Contribution

We accept contributions in the following formats, listed in order of preference:

  1. Markdown (MD): Markdown is the preferred format for contributions. It is well-supported by the wiki platform.
  2. HTML: Contributions in HTML are accepted but are not the preferred format. Ensure that your HTML is well-structured and compliant.
  3. Plaintext: While plaintext contributions are accepted, they should be used sparingly, as they offer limited formatting options.

Wiki Platform

Our wiki platform runs on GitHub Flavored Markdown (GFM), a modern and user-friendly platform for documentation. To ensure your contributions are compatible with our platform, please refer to Basic writing and formatting syntax Markdown Guide.

Discussion and Comments

Users can engage in discussions and offer comments directly on the wiki platform. However, please note the following:

  • To participate in discussions and comment on articles, users must be logged in.
  • Users can log in to the wiki platform using their GitHub credentials, simplifying the authentication process.

Suggestions and Proposals

If you wish to make suggestions or propose new content or changes to existing content, we encourage you to create GitHub Issues on our repository. This helps us manage and track suggestions, making it easier for the community to engage with your proposals.

Contribution Workflow

  1. Fork the DigiByte-Core/digibyte Repository to your GitHub account.

  2. Clone DigiByte-Core/digibyte/wiki Repository, Clone this locally.

  3. Create an issue or contact the repository maintainers: Go to the original repository's Issues tab and create a new issue. In the issue, explain your changes and provide a link to your forked wiki repository.

  4. The maintainers can review your changes and merge them into the main wiki repository if they find them valuable.

Your contributions are highly appreciated, and they play a crucial role in maintaining and improving the DigiByte Blockchain Community Wiki. Thank you for being part of our community!

If you have any questions or need assistance with the contribution process, please feel free to reach out to our maintainers or community members.

Git Contribution Guide

This guide provides a quick reference for using Git to contribute to the GitHub DigiByte-Core digibyte Wiki. It assumes you have a basic understanding of Git.

Cloning the Repository

  1. Fork the Repository: Click the Fork button on the DigiByte-Core/digibyte to create a copy in your GitHub account.

    Note: GitHub wikis don't have a direct fork button like repositories do. However, you can still fork the content by following these steps:

  2. Clone DigiByte-Core/digibyte/wiki Repository

    Go to the wiki page of the original repository.
    Click the Clone this wiki locally link and copy the URL.
    Use the git clone command in your terminal:

git clone https://github.com/DigiByte-Core/digibyte.wiki.git
  1. Add a Remote for Your Forked Wiki
    Navigate to the cloned wiki directory:
cd digibyte.wiki
  1. Add a remote for your forked repository's wiki:
git remote add forked-wiki https://github.com/yourusername/digibyte.wiki.git
  1. Push the Wiki Content to Your Fork
    Push the cloned wiki content to your forked repository's wiki:
git push forked-wiki master

Note: By following these steps, you’ll ensure that the wiki content from the original repository is carried over to your fork.

Create an Issue

Description
I have made some improvements and updates to the DigiByte wiki and would like to contribute these changes to the original repository.

Steps Taken

  1. Forked the original DigiByte wiki repository.
  2. Made necessary changes and updates in my forked repository.
  3. Committed and pushed the changes to my forked repository.

Link to Forked Wiki Repository
You can review my changes here: My Forked Wiki Repository

Request
Please review the changes in my forked repository. If you find them valuable, kindly merge them into the main DigiByte wiki repository.

Thank you!

Additional Context
If there are any questions or further modifications needed, please let me know.

That's it! Your contributions to the DigiByte Blockchain Community Wiki will go through the review process, and if approved, they will be merged into the main repository. Thank you for your contributions!

Clone this wiki locally