Skip to content

Commit 232406f

Browse files
Updates project info files
1 parent cec80c7 commit 232406f

File tree

4 files changed

+29
-22
lines changed

4 files changed

+29
-22
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,31 @@
11
# Contributing to Dev Proxy
22

3-
The best way to contribute initially is to download and try Dev Proxy and then give us your feedback, both positive and negative, this will help us shape the future direction of this tool. At present we are not accepting community code contributions but will be opening up to accept pull requests in the future.
3+
We're excited to accept contributions!
44

5-
## Our foundation
5+
## You have an idea for a new feature
66

7-
The Dev Proxy is built with .NET 9 and uses the [Unobtanium Web Proxy](https://github.com/svrooij/unobtanium-web-proxy).
7+
Awesome! Good ideas are invaluable for every product. Before you start hacking away, please check if there is no similar idea already listed in the [issue list](/dotnet/dev-proxy/issues). This ensures that your idea is unique and not being worked on. If you don't find a similar idea, create a new issue describing your idea. Once we agree on the feature scope and architecture, the feature will be ready for building. Don't hesitate to mention this in the issue if you'd like to build the feature yourself.
8+
9+
## You have a suggestion for improving an existing feature
10+
11+
Nothing is perfect. If you have an idea for how to improve an existing feature or Dev Proxy itself, let us know by submitting an issue in the [issue list](/dotnet/dev-proxy/issues). We value your input. Some things are done for a reason, but some are not. Let's discuss what you think and see how the project could be improved for everyone.
812

9-
## Reporting issues and suggesting new features
13+
## You've found a bug
1014

11-
Please use [GitHub Issues](https://github.com/dotnet/dev-proxy/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) for bug reports and feature request.
15+
Bugs happen. When you find a bug, please have a look at the [issue list](/dotnet/dev-proxy/issues) to validate if a similar bug has already been logged. This helps avoid duplicate bug reports. If you don't find a similar bug report, let us know what isn't working and provide steps to reproduce it. If we can't reproduce your bug, we will ask you for clarification, which will only delay the resolution.
1216

13-
We highly recommend you browse existing issues first.
17+
## Fixing typos
1418

15-
## Contributing to the project
19+
Typos are embarrassing! Most PRs that fix typos will be accepted immediately. To make it easier to review the PR, please narrow the focus instead of sending a huge PR of fixes.
1620

17-
We will be opening up to accept code contributions in the future, however at present this project is source open.
21+
## DO's & DON'Ts
1822

19-
> NOTE: When we start accepting community code contributions a signed a contribution license agreement will be required for all contributions and will be checked automatically on new pull requests. You will be asked to read and sign the agreement https://cla.microsoft.com/ after submitting a request to this repository.
23+
- **DO** follow the same project and test structure as the existing project.
24+
- **DO** keep discussions focused. When a new or related topic comes up, it's often better to create a new issue than to side-track the conversation.
25+
- **DO NOT** submit PRs for coding style changes. These changes can cause unnecessary conflicts and make the review process more complicated.
26+
- **DO NOT** surprise us with big PRs. Instead, file an issue and start a discussion so we can agree on a direction before you invest a large amount of time.
27+
- **DO NOT** commit code you didn't write. We encourage you to contribute your own work to maintain
28+
29+
## Our foundation
30+
31+
The Dev Proxy is built with .NET 9 and uses the [Unobtanium Web Proxy](https://github.com/svrooij/unobtanium-web-proxy).

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) Microsoft Corporation.
3+
Copyright (c) .NET Foundation and Contributors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Begin with our [tutorial](https://learn.microsoft.com/microsoft-cloud/dev/dev-pr
6565

6666
Fail requests (with a 50% chance) and respond with `429 Too Many Requests` or `503 Service Unavailable`:
6767

68-
```
68+
```text
6969
devproxy --failure-rate 50 --no-mocks --allowed-errors 429 503
7070
```
7171

@@ -98,11 +98,6 @@ devproxy --failure-rate 50 --no-mocks --allowed-errors 429 503
9898
- detect minimal Microsoft Graph API permissions
9999
- check for excessive Microsoft Graph API permissions
100100

101-
## Trademarks
102-
103-
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft’s Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.
104-
105-
## A Microsoft Hackathon 2022 Project
106-
107-
The initial build of this project was completed in the week of 5-9 September 2022 by Waldek Mastykarz, Gavin Barron and Garry Trinder
101+
### .NET Foundation
108102

103+
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).

THIRD PARTY NOTICES

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
This file is based on or incorporates material from the projects listed below (Third Party OSS). The original copyright notice and the license under which Microsoft received such Third Party OSS, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party OSS to you under the licensing terms for the Microsoft product or service. Microsoft
2-
reserves all other rights not expressly granted under this agreement, whether by implication, estoppel or otherwise.
1+
This file is based on or incorporates material from the projects listed below (Third Party OSS). The original copyright notice and the license under which Microsoft received such Third Party OSS, are set forth below. Such licenses and notices are provided for informational purposes only. Microsoft licenses the Third Party OSS to you under the licensing terms for the Microsoft product or service. Microsoft reserves all other rights not expressly granted under this agreement, whether by implication, estoppel or otherwise.
32

4-
Titanium.Web.Proxy - <= 3.2.0
5-
Copyright (c) 2015 titanium007
3+
Unobtanium.Web.Proxy
4+
Copyright (c) 2015-2023 titanium007
5+
Copyright (c) 2024-... Stephan van Rooij
66

77
Provided for Informational Purposes Only
88

0 commit comments

Comments
 (0)