diff --git a/README.md b/README.md index 5f2d3863..7016e7e9 100644 --- a/README.md +++ b/README.md @@ -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).