Search
K

Contributing and Feedback Guide

Contributing and Feedback Guide. First of all, thank you for taking the time to provide feedback and/or contribute to the XDC Community Developer Portal! We’re continually working on improving these documents with community input and we appreciate any feedback, whether it's helping to contribute to further documentation or code, grammar issues, or simply a suggestion or improvement. If you want to contribute and make changes to the Docs, this page will guide you through the contribution process, outlining which tools we use and the steps you need to follow to contribute.

Providing Feedback

There are a few ways you can provide feedback:

Overview and basics

  • The source code for this documentation is hosted on Github and uses a service called Gitbook for publishing its documentation.
  • The documents are written using Markdown mark up language.
  • All contributions must be licensed under Creative Commons Zero v1.0 Universal.

Getting started and prerequisites

For contributing to the manual, the following is needed to get started:

Gitbook & GitHub integration

This repo has two branches:
  • master: reserved for production only.
    • Any changes merged in to master will automatically be reflected on Gitbook.
  • develop: the default branch used for development and content changes.

How to contribute

Trying to edit or create a file in this repository will create your fork automatically. You can then edit pages or create new pages, and commit your changes and file a pull requests one document/issue at a time. For content changes or new pages, you can use the GitHub online editor:
  • Open the page you want to edit on your forked version of the repo on GitHub and press the Edit icon (pen icon).
  • When have finalized your changes, scroll to the bottom of the page and write a description of the changes you're proposing under the "Commit changes" section. Then select Create a new branch for this commit and start a pull request and click on Propose file change. This will direct you to the Pull request page
  • On the Pull request page, write a short comment explaining why are proposing those changes and publish your pull request clicking on Create pull request.
Any pull request should be based on the develop branch. We will not consider pull requests made to master. For more information, please see see Using Pull Request and Fork a Repo if you are not familiar with Pull Requests.

Code review process

Editors will review and comment on pull requests. We may suggest changes, improvements, or alternatives, in which case the original contributor will be tagged directly so follow-up instructions are clear. There may be times where moderators will make commits to your fork directly for clarity.

Community

If you have any other questions about contributing to our documentation, please reach out on the XDC Community Discord Server.