Skip to content

docs: add contributing section to README and emphasize issues in CONTRIBUTING.md #1274

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.

Sign up for GitHub

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

Merged
chaliy merged 1 commit into from
Apr 14, 2026
+10 −0
Merged

docs: add contributing section to README and emphasize issues in CONTRIBUTING.md #1274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Thanks for your interest in contributing to Bashkit!

## How to Contribute

The easiest and most valuable way to contribute is to [create an issue](https://github.com/everruns/bashkit/issues). Bug reports, feature requests, compatibility gaps, and questions all help us prioritize and improve bashkit. A well-described issue is often more impactful than a pull request.

If you'd like to contribute code, read on.

## Setup

```bash
Expand Down
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,10 @@ Bashkit is an independent implementation that draws design inspiration from seve

No code was copied from any of these projects. See [NOTICE](NOTICE) for full details.

## Contributing

The best way to contribute is to [open an issue](https://github.com/everruns/bashkit/issues) — bug reports, feature requests, and questions all help improve bashkit. If you'd like to contribute code, see [CONTRIBUTING.md](CONTRIBUTING.md) for setup and workflow details.

## Ecosystem

Bashkit is part of the [Everruns](https://everruns.com) ecosystem.
Expand Down
Loading