DAOmasons RuleBook

This repository hosts the VitePress site for the DAOmasons RuleBook. We welcome contributions from the community. Please follow the guidelines below to contribute.

Getting Started

Prerequisites

Git
Node.js (version specified in .nvmrc)

Setting Up the Project

Clone the Repository:

git clone https://github.com/DAOmasons/RuleBook.git
cd RuleBook

Install Dependencies:
```
npm install
```
Run Locally:
```
npm run docs:dev
```
The site should now be running on http://localhost:5173.

Contributing

Creating a Feature Branch

Always create a new branch for your work, regardless of its size.
Use a clear and descriptive name for your branch, like add-contributing-guidelines.
```
git checkout -b <your-branch-name>
```

Making Changes

Make your changes locally and test them.
Ensure your changes do not break the build.
Follow the coding standards and guidelines of the project.

Submitting a Pull Request

Push your changes:
```
git push origin <your-branch-name>
```
Create a Pull Request:
- Navigate to the repository on GitHub.
- Click on "Compare & pull request" next to your branch.
- Provide a clear and detailed description of your changes.
- Select Main as the base branch for your pull request.
Ensure All Checks Pass:
- Your pull request will undergo automated checks.
- Make sure all these checks pass. If not, resolve any issues.
Deployment Verification:
- Verify that your changes are compatible with deployment on Vercel.
- If there are deployment issues, make necessary fixes before the pull request can be merged.
Await Review:
- A project maintainer will review your pull request.
- Address any feedback to ensure a smooth merge process.

Resources

VitePress Installation Guide

Questions or Issues

If you have any questions or encounter any issues, please open an issue in the GitHub repository.

Thank you for contributing to DAOmasons RuleBook!

DAOmasons / RuleBook