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.

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

docs: add contrib #18

Merged
merged 1 commit into from
Jul 29, 2024
Merged

docs: add contrib #18

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
32 changes: 30 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Generate OpenAPI specification for Laravel Applications

[![Latest Stable Version](http://poser.pugx.org/tartanlegrand/laravel-openapi/v)](https://packagist.org/packages/tartanlegrand/laravel-openapi)
![Packagist Version](https://img.shields.io/packagist/v/tartanlegrand/laravel-openapi?style=flat-square)
[![MIT Licensed](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Build Status](https://github.com/tartanlegrand/laravel-openapi/workflows/Tests/badge.svg)](https://github.com/tartanlegrand/laravel-openapi/actions)
![GitHub branch status](https://img.shields.io/github/checks-status/TartanLeGrand/laravel-openapi/main?style=flat-square)
[![Total Downloads](https://img.shields.io/packagist/dt/tartanlegrand/laravel-openapi.svg?style=flat-square)](https://packagist.org/packages/tartanlegrand/laravel-openapi)

## Documentation
Expand All @@ -12,3 +12,31 @@ You'll find the documentation on https://tartanlegrand.github.io/laravel-openapi
## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

## Community and Contributing

We invite you to join our community and contribute to the project. Whether you're interested in development, reporting bugs, or simply providing suggestions and feedback, all contributions are welcome!

### How to Contribute

1. **Report a Bug**: Open a [GitHub issue](https://github.com/TartanLeGrand/laravel-openapi/issues) to report bugs or propose improvements.
2. **Submit Code**: For development details, see the [CONTRIBUTING](CONTRIBUTING.md) guide. For major changes, including CLI interface changes, please open an issue first to discuss what you would like to change.
3. **Documentation**: Help us improve the documentation on [our site](https://tartanlegrand.github.io/laravel-openapi).

Thanks to everyone who has contributed, including bug reports, code, feedback, and suggestions!

### List of Contributors

A big thank you to all who have contributed to this project. Here are some of our most active contributors:

<a href="https://github.com/tartanlegrand/laravel-openapi/graphs/contributors">
<img src="https://contrib.rocks/image?repo=tartanlegrand/laravel-openapi" />
</a>

If you would like to see your name here, start contributing today!

## Join Us

Connect with other users and contributors on our [discussion forum](https://github.com/TartanLeGrand/laravel-openapi/discussions) and join the conversation around the project.

We ❤️ contributions big or small. Thank you for being part of our community and helping improve this open source project.