-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26 from shaniit-org/docs/readme
added contribution guide
- Loading branch information
Showing
1 changed file
with
71 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# Contribution Guide | ||
|
||
Welcome to our SvelteKit project! We're thrilled that you're interested in contributing. Below is a simple guide to help you get started. | ||
|
||
## Getting Started | ||
|
||
1. **Fork the Repository:** | ||
|
||
- Click on the "Fork" button at the top right corner of the repository to create a copy in your GitHub account. | ||
|
||
2. **Clone the Repository:** | ||
|
||
- Clone your forked repository to your local machine. | ||
```bash | ||
git clone https://github.com/shaniit-org/SIIT | ||
cd SIIT | ||
``` | ||
|
||
3. **Install Dependencies:** | ||
- Make sure you have Node.js installed on your machine. | ||
- Install project dependencies. | ||
```bash | ||
pnpm install | ||
``` | ||
|
||
## Making Changes | ||
|
||
1. **Create a Branch:** | ||
|
||
- Create a new branch for your feature or bug fix. | ||
```bash | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
2. **Make Changes:** | ||
|
||
- Implement your changes or add new features. | ||
|
||
3. **Test Locally:** | ||
|
||
- We don't have any tests implemented yet but we do have `Vitest` and `Playwright` in mind. Let us know if you are down to try out. We would love to hangout and chat. | ||
4. **Commit Changes:** | ||
- Commit your changes with a descriptive commit message. | ||
```bash | ||
git add . | ||
git commit -m "Add your descriptive message here" | ||
``` | ||
## Submitting Changes | ||
1. **Push to Your Fork:** | ||
- Push your changes to your forked repository. | ||
```bash | ||
git push origin feature/your-feature-name | ||
``` | ||
2. **Create a Pull Request (PR):** | ||
- Go to your forked repository on GitHub. | ||
- Click on the "New Pull Request" button. | ||
- Provide a descriptive title and details about your changes. | ||
- Submit the pull request. | ||
## Code Review | ||
Once you've submitted a pull request, we will review your changes. Please be patient and be open to feedback. We appreciate your contribution! | ||
|
||
## Thank You | ||
|
||
Thank you for contributing to our SvelteKit project. Your efforts help make our project better for everyone. If you have any questions or need assistance, feel free to reach out. Happy coding! |