Skip to content

Commit

Permalink
Merge pull request #273 from Renumics/contributions
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
steffenslavetinsky authored Oct 19, 2023
2 parents 398b482 + dff7375 commit 22b30df
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contribute to Spotlight

Everyone is welcome to contribute, and we value everybody's contribution. Code
contributions are not the only way to help the community.
Reported bugs, suggested features, contributing design ideas,
or offering feedback are alse extremely valuable to us.

Technical details on how to contribute can be found in our [documentation](https://renumics.com/docs/development).

## Ways to contribute

There are several ways you can contribute to Spotlight:

* Fix outstanding issues.
* Implement new features.
* Submit issues related to bugs or desired new features.
* Share your use case

If you don't know where to start, you might want to have a look at [hacktoberfest issues](https://github.com/Renumics/spotlight/issues?q=is%3Aissue+is%3Aopen+label%3Ahacktoberfest)
and our guide on how to create a [new Lens](https://renumics.com/docs/development/lenses).
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,3 +153,11 @@ We have added crash report and perfomance collection. We do NOT collect user dat
- 🤗 [Huggingface](https://huggingface.co/renumics) example spaces and datasets
- 🏀 [Playbook](https://renumics.com/docs/playbook/) for data-centric AI workflows
- 🍰 [Sliceguard](https://github.com/Renumics/sliceguard) library for automatic slice detection

## Contribute

We are currently participating in the running [Hacktoberfest 2023](https://hacktoberfest.com/).

If you would like to contribute to Spotlight, the easiest way is to have a look at our [Contribution Docs](https://renumics.com/docs/development) and the [CONTRIBUTING.md](./CONTRIBUTING.md).

We are also equally happy about non-code contributions -- whether it's reporting bugs, suggesting features, contributing design ideas, or offering feedback, every non-code contribution is highly valued and helps make our project better for everyone.

0 comments on commit 22b30df

Please sign in to comment.