Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
101 lines (62 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

101 lines (62 loc) · 3.3 KB
Raw

Contributing

Welcome to the official repository for Rive's documentation, available at https://rive.app/docs.

We welcome any and all external contributions.

How to contribute

1. Find something to work on

Start with the Contributing backlog or browse issues labeled good first issue.

Before starting, comment on the issue to claim it.

2. Fork the repository

Fork the rive-app/rive-docs repository to your GitHub account.

After forking, clone your fork locally and create a branch from main.

git clone https://github.com/YOUR_USERNAME/rive-docs.git
cd rive-docs
git checkout main
git pull origin main
git checkout -b docs/my-change

3. Make your changes

Make your updates in the relevant documentation files.

4. Preview your changes

Rive uses Mintlify for documentation. Follow Mintlify's Local Development guide to set up your local environment for previewing your changes locally.

5. Commit your changes

Commit messages should follow the Conventional Commits specification.

For most documentation changes, use the docs type.

git add .
git commit -m "docs(editor): update hierarchy documentation"

6. Open a pull request

Push your branch to your fork and open a pull request against rive-app/rive-docs.

git push origin docs/my-change

When creating your pull request, make sure main is selected as the base branch.

Your pull request should include:

  • A clear title that summarizes the full change
  • A brief description of what changed
  • Links to any related issues
  • Screenshots or preview links, when helpful

7. Review and merge

Reviewers will automatically be assigned following the assignments in CODEOWNERS.

After your pull request is approved, the Rive team will merge it. Commits are squashed when merging, so make sure your pull request title clearly summarizes the full change.

Best Practices

Images

When adding images, add them to the images folder, in a subdirectory similar to the file structure for documentation.

When embedding images, make sure to add descriptive alt-text.

Example Image Directories:

  • All runtimes: images/runtimes/my-image.jpg
  • All game runtimes: images/game-runtimes/my-image.jpg
  • iOS: images/runtimes/apple/my-image.jpg
  • Android: images/runtimes/android/my-image.jpg
  • Web: images/runtimes/web/my-image.jpg
  • Unity: images/game-runtimes/unity/my-image.jpg
  • Unreal: images/game-runtimes/unreal/my-image.jpg

Links:

When adding links to another page within the documentation, make sure the url is relative to the root.

// Don't
[Hierarchy](../editor/interface-overview/hierarchy)

// Do
[Hierarchy](/editor/interface-overview/hierarchy)