Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vratskyi authored Feb 29, 2024
1 parent 5a3fd1c commit 6b28199
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Astro Framework - ov-template - Contributing Guidelines

Thank you for your interest in contributing to the development of Astro Framework's "ov-template"! We welcome your contributions.

## How to Contribute

1. **Fork the repository**.

2. **Clone** your fork to your local machine:

```bash
git clone https://github.com/your_username/ov-template.git
```

3. **Install dependencies**:

```bash
cd ov-template
npm install
```

4. Create a branch for your work:

```bash
git checkout -b your-feature
```

5. **Make changes** and ensure your code adheres to the project's standards.
6. **Commit your changes** with a clear message:
```bash
git commit -m "Added your new feature"
```
7. **Push the changes** to your fork:
```bash
git push origin your-feature
```
8. **Create a Pull Request** with a description of your changes.
## Code Standards
- Adhere to the coding style defined in the [Astro Framework documentation](https://docs.astro.build/en/getting-started/).
- Always add tests for your code.
- Follow the DRY (Don't Repeat Yourself) and KISS (Keep It Simple, Stupid) principles.

## Bug Reports and Feature Requests

If you find a bug or have a feature request, please create an Issue in the "Issues" section of our repository.

## License

Your contribution will automatically be considered as an agreement to the project's license. Please make sure you have read the [LICENSE](https://github.com/vratskyi/vratskyi.github.io/blob/master/LICENSE).
Thank you for contributing to Astro Framework's "ov-template"!

0 comments on commit 6b28199

Please sign in to comment.