Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create CONTRIBUTING.md #11

Merged
merged 1 commit into from
Dec 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Contributing to ink-divider

Thank you for considering contributing to ink-divider 😀! We welcome contributions from everyone. By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).

## Setting Up the Development Environment

1. [Fork the Project](https://github.com/JureSotosek/ink-divider/fork)
2. Create a new branch for your changes:
```bash
git checkout -b my-feature-branch
```
3. Install the dependencies:
```bash
bun install
```

If you don't have [Bun](https://bun.sh/) installed, you can install it using this command:

### Windows

```powershell
powershell -c "irm bun.sh/install.ps1 | iex"
```

### Linux, macOS, Windows ([WSL](https://learn.microsoft.com/windows/wsl/install))

```bash
curl -fsSL bun.sh/install | bash
```


## Running Tests and Building the Project

To run the tests, use the following command:
```bash
bun run test
```

To build the project, use the following command:
```bash
bun run build
```

## Submitting Pull Requests

1. Commit your Changes (git commit -m 'Add some AmazingFeature')
2. Push your branch to your fork:
```bash
git push origin my-feature-branch
```
3. [Open a Pull Request on GitHub](https://github.com/JureSotosek/ink-divider/pulls) and provide a description of your changes.