Page MenuHomePhorge
Files F115341

No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..fbd1d18
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,38 @@
+# Contributing
+
+## Open an issue
+
+If you've found a bug or would like to discuss a new feature, start by [opening an issue](https://github.com/open-api-spex/open_api_spex/issues/new).
+Where possible, please refer to the relevant sections of the Open API Specification 3.0 or JSON Schema Specification:
+
+* https://swagger.io/docs/specification/
+* https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.0.md
+* https://json-schema.org/understanding-json-schema/
+
+
+## Send a Pull Request
+
+Link your pull request to the issue opened earlier, eg `fixes #123`.
+Please be patient as maintainers are generally volunteering their time to support the project 🙂
+
+## Get Help
+
+You can ask for help using OpenApiSpex by:
+
+* [Opening an issue](https://github.com/open-api-spex/open_api_spex/issues/new) - you may have run in to a bug or poorly documented feature!
+* Using the [open_api_spex slack channel](https://elixir-lang.slack.com/messages/CPEN5UW1X)
+* Using the [Elixir Forum thread](https://elixirforum.com/t/openapispex-openapi-swagger-3-0-for-plug-apis/15614)
+
+## Releasing (Maintainers Only)
+
+To ship a release to Hex.pm, complete the following checklist:
+
+ - Update the `@version` attribute in `mix.exs`
+ - Update the `Installation` section of the `README.md` file with the new version
+ - Commit and tag the `master` branch with the version and a leading `v`, eg: `v3.14.15`
+ - Review the `CHANGELOG.md` file, adding a line for each pr / issue and a larger description for significant changes.
+ - Confirm the project builds and all tests pass on your machine `mix clean; mix test`
+ - Confirm the docs build successfully and do not contain obvious formatting errors `mix docs; open doc/index.html`
+ - Push master branch to `open_api_spex` repo
+ - Push package to Hex: `mix hex.publish`
+ - Add a release announcement to the [Elixir Forum thread](https://elixirforum.com/t/openapispex-openapi-swagger-3-0-for-plug-apis/15614)
\ No newline at end of file

File Metadata

Mime Type
text/x-diff
Expires
Wed, Nov 27, 10:30 PM (1 d, 22 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
40761
Default Alt Text
(2 KB)

Event Timeline