Skip to content

Commit

Permalink
Cleanup and add contribution guidelines to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
samholmes committed Jul 24, 2024
1 parent 321aab6 commit 7fefa72
Showing 1 changed file with 30 additions and 14 deletions.
44 changes: 30 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,40 +17,56 @@ Make sure you have the following installed on your machine:

1. **Clone the repository**:

```sh
git clone https://github.com/yourusername/san-diego-devx.git
cd san-diego-devx
```

2. **Install dependencies**:

```sh
npm install
```

3. **Start the development server with the following command:**:

```sh
npm run dev
```

The site will be running at http://localhost:3000.

### This project uses DaisyUI, a Tailwind CSS component library.
**Note: This project uses DaisyUI, a Tailwind CSS component library.**

### Contributing
## Contributing

We welcome contributions from the community! If you have suggestions or improvements, feel free to open an issue or submit a pull request.

### Steps to Contribute
### Guidelines

1. **Fork the repository**
The project uses Prettier and ESLint for code formatting and linting.
Integrating ESLint in your editor is recommended to ensure that the code
formatting in addition to the linting rules are followed. For VSCode, you can
use [the ESLint extension](https://github.com/Microsoft/vscode-eslint).

2. **Create a new branch**:
Pre-commit hooks are in place to ensure that the code is properly formatted
before a commit is added to the repo. The pre-commit hook runs the precommit
script (`npm run precommit`).

git checkout -b feature-name
### Steps to Contribute

1. **Fork the repository**
2. **Create a new branch**:
```sh
git checkout -b feature-name
```
3. **Make your changes and commit**

git add .
git commit -m "Add some feature"

```sh
git add .
git commit -m "Add some feature"
```
4. **Push to the branch**

git push origin feature-name

4. **Open a pull request on Github**
```sh
git push origin feature-name
```
5. **Open a pull request on Github**

0 comments on commit 7fefa72

Please sign in to comment.