Skip to content

Commit 14c5a81

Browse files
committed
Add project status and update contributing guidleines
1 parent a935e24 commit 14c5a81

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@
1111
- Easy to extend and customize. Communicate session tokens to/from clients in HTTP headers or request/response bodies.
1212
- Efficient design. Smaller, faster and uses less memory than [gorilla/sessions](https://github.com/gorilla/sessions).
1313

14+
## Project status
15+
16+
This project has reached a **stable** status. It is actively maintained with ongoing bug fixes and essential updates, and significant alterations to the API or behavior are not expected. Please see the [contributing guidelines](#contributing) before submitting any PRs.
17+
1418
## Instructions
1519

1620
- [SCS: HTTP Session Management for Go](#scs-http-session-management-for-go)
@@ -311,10 +315,10 @@ For a complete working example, please see [this comment](https://github.com/ale
311315

312316
Note that the `http.ResponseWriter` passed on by the [`LoadAndSave()`](https://pkg.go.dev/github.com/alexedwards/scs/v2#SessionManager.LoadAndSave) middleware does not support the `http.Flusher` interface directly. This effectively means that flushing/streaming is only supported by SCS if you are using Go >= 1.20.
313317

314-
### Compatibility
318+
## Compatibility
315319

316320
You may have some problems using this package with Go frameworks that do not propagate the request context from standard-library compatible middleware, like [Echo](https://github.com/alexedwards/scs/issues/57) and [Fiber](https://github.com/alexedwards/scs/issues/106). If you are using Echo, you may wish to evaluate using the [echo-scs-session](https://github.com/canidam/echo-scs-session) package for session management.
317321

318-
### Contributing
322+
## Contributing
319323

320-
Bug fixes and documentation improvements are very welcome! For feature additions or behavioral changes, please open an issue to discuss the change before submitting a PR. Additional store implementations will not merged to this repository (unless there is very significant demand) --- but please feel free to host the store implementation yourself and open a PR to link to it from this README.
324+
Bug fixes and documentation improvements are very welcome! This package is stable, so for any feature additions or behavioral changes please open an issue to make a proposal before submitting a PR. Additional store implementations will not merged to this repository (unless there is very significant demand) --- but please feel free to host the store implementation yourself and open a PR to link to it from this README.

0 commit comments

Comments
 (0)