Skip to content

Commit b024e42

Browse files
committed
docs: clarifications in docs
Signed-off-by: Shane Utt <shaneutt@linux.com>
1 parent a0e4b3e commit b024e42

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[![MSRV: 1.94](https://img.shields.io/badge/MSRV-1.94-brightgreen.svg)](https://blog.rust-lang.org/)
88
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
99

10-
Praxis is a high performance and security-first proxy server and framework for AI and cloud-native workloads.
10+
Praxis is a high-performance and security-first proxy server and framework for AI and cloud-native workloads.
1111

1212
## Getting Started
1313

@@ -25,12 +25,18 @@ Praxis is a high performance and security-first proxy server and framework for A
2525

2626
## Contributing
2727

28-
Issues and pull requests are welcome. Familiarize yourself
28+
[Issues] and [pull requests] are welcome. Familiarize yourself
2929
with the following documentation first:
3030

3131
- [Architecture](docs/architecture.md)
3232
- [Conventions](docs/conventions.md)
3333
- [Development](docs/development.md)
3434
- [Benchmarks](docs/benchmarks.md)
3535

36-
For larger changes, open an issue or discussion first.
36+
For larger changes open a [discussion] with a detailed description
37+
of what the change is so it can be discussed prior to a pull
38+
request.
39+
40+
[Issues]:https://github.com/praxis-proxy/praxis/issues/new
41+
[pull requests]:https://github.com/praxis-proxy/praxis/compare
42+
[discussion]:https://github.com/praxis-proxy/praxis/discussions

0 commit comments

Comments
 (0)