Skip to content

Commit

Permalink
Split out getting help / contributing back & add dev docs (#587)
Browse files Browse the repository at this point in the history
* Readme - split out getting help / contributing back & add dev docs

- add basic development docs

* Update README.md

Co-authored-by: Marco Roth <marco.roth@intergga.ch>
  • Loading branch information
lb- and marcoroth committed Oct 4, 2022
1 parent f690a6a commit 9686943
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Expand Up @@ -44,16 +44,27 @@ You can use Stimulus with any asset packaging systems. And if you prefer no buil

See the [Installation Guide](https://stimulus.hotwired.dev/handbook/installing) for detailed instructions.

## Getting Help & Contributing Back
## Getting Help

Looking for the docs? Once you've read through the Handbook, consult the [Stimulus Reference](https://stimulus.hotwired.dev/reference/controllers) for API details.

Have a question about Stimulus? Connect with other Stimulus developers on the [Hotwire Discourse](https://discuss.hotwired.dev/) community forum.

## Contributing Back

Find a bug? Head over to our [issue tracker](https://github.com/hotwired/stimulus/issues) and we'll do our best to help. We love pull requests, too!

We expect all Stimulus contributors to abide by the terms of our [Code of Conduct](CODE_OF_CONDUCT.md).

### Development

- Fork the project locally
- `yarn install`
- `yarn start` - to run the local dev server with examples
- `yarn test` - to run the unit tests
- `yarn lint` - to run the linter with ESLint
- `yarn format` - to format changes with Prettier

## Acknowledgments

Stimulus is [MIT-licensed](LICENSE.md) open-source software from [Basecamp](https://basecamp.com/), the creators of [Ruby on Rails](http://rubyonrails.org).
Expand Down

0 comments on commit 9686943

Please sign in to comment.