Skip to content

Commit

Permalink
docs: update contributing guidelines (#1644)
Browse files Browse the repository at this point in the history
Co-authored-by: Chris McQuaid <[email protected]>
Co-authored-by: Anthony Fu <[email protected]>
  • Loading branch information
3 people authored Jun 2, 2024
1 parent cea5b0b commit 75dfdc4
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,18 @@ Excited to hear that you are interested in contributing to this project! Thanks!

## Documentation

Documentation has now been moved to the [`slidevjs/docs`](https://github.com/slidevjs/docs) repo.
Documentation is now being synced from the [`/docs`](https://github.com/slidevjs/slidev/tree/main/docs) folder to the [`slidevjs/docs`](https://github.com/slidevjs/docs) repo.

All Pull Requests for documentation changes should still be made to this repository. Any merged changes will be automatically mirrored to the new documentation repo.

The easiest way to contribute documentation to this project is to follow these steps:

1. [Fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo), for example to `https://github.com/octocat/slidev`, where `octocat` is your GitHub username.
2. Clone the newly forked repo from your GitHub account
3. Create a new branch to add your work to, i.e. `git checkout -b docs/update-contributing-guidelines`
4. Make your changes and commit them
5. Push the branch to your fork
6. Go to [https://github.com/slidevjs/slidev/pulls](https://github.com/slidevjs/slidev/pulls), there should be a "Compare & Pull Request" button, where you can create a PR.

## Setup (in your browser)

Expand Down

0 comments on commit 75dfdc4

Please sign in to comment.