Skip to main content

Contribution Guidelines

So you've decided to contribute to Figment Docs? We're excited to have you among our contributors! We welcome all kind of contribution to the documentation. Please review the guidelines below to make sure your contribution PR follows the style and quality of the existing content on Figment Docs.

Contribution Process

1. Submit an issue

  • If you want contribute & improve docs by fixing guides, content, typos, reporting deprecated endpoints then please go ahead and create a new issue first.
  • Submit the issue with as much as details you can.
note

If you want to contribute to JSON-RPC methods by reporting deprecated methods, updating existing methods and adding new methods, please create a new issue with complete details and our team will resolve it because JSON-RPC API methods can only be modified by internal team members.

2. Fork the repository

  • Now, fork and then clone the Figment Documentation repository on GitHub. It's important that you have the most recent version of documentation before you start your contribution. If you have already cloned it, make sure to pull down the latest changes.
  • Create a new git branch in your local repository, you can name it however you want, though we prefer if you pick a name relevant to your contribution. (Example: typo-fixes).

3. Contribute

  • Make the changes in the content and docs as what you described in your issue, once you're done & ready to submit your changes open a Pull Request from your branch. We'll be notified and will start the review process:
  • Please make every effort to submit only the final draft of your changes. If there are significant changes to be made before we can merge your PR, it will take much longer to review and have you make the appropriate changes.
  • Once we've reviewed your submission and you've made any necessary changes, we'll merge the Pull Request and the contributed changes will be published on Figment Docs.

Guideline and Rules for Contributing

There are a few basic ground-rules for contributors:

  1. No --force pushes or modifying the Git history in any way.
  2. Pull requests are preferred to issues, especially for small changes such as typos. Issues should be used for generic or broad-based changes or missing content. Suggestions and requests are encouraged.
  3. Only use non-master branches.
  4. Use Markdown properly throughout your changes. Refer to GitHub's markdown guide.
  5. Do not use any markdown formatting in a section heading.
  6. Remember to leave a blank line before and after all code blocks.
  7. Use a linter & prettifier before pasting your code into code blocks. We recommend eslint for JavaScript/React. Use prettier for code formatting.