From ee4dde55779f3ae707a016f5c5699ebc701b769f Mon Sep 17 00:00:00 2001 From: Israel Ekpo Date: Fri, 11 Jul 2025 17:58:24 -0400 Subject: [PATCH 1/4] Adding Guidance Documentation for Contributors This satisfies #16 new file: CONTRIBUTORS.md --- CONTRIBUTORS.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 CONTRIBUTORS.md diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..f745db2 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,47 @@ +## Guidance for Contributors + +We would sincerely appreciate your contributions to the [FastA2A](https://ai.pydantic.dev/a2a/) project. + +### Areas of Contribution + +You can contribute to the project in the following areas: +- project documentation +- python code updates (adding functionality, fixing bugs, adding code documentation etc.) +- writing new unit tests, fixing existing unit tests +- reporting issues +- making suggestions for feature requestions and improvements +- starting and contributing to discussions +- creating examples and tutorials for the [FastA2A](https://ai.pydantic.dev/a2a/) project. + +Before reporting new issues, take a look at [existing issues](https://github.com/pydantic/fasta2a/issues) to ensure that you are not creating duplicates. + +### Pre-Commit Checks before Sending in your Pull Requests + +Clone for fork of the [FastA2A repo](https://github.com/pydantic/fasta2a/fork) and cd into that directory + +````bash + +git clone git@github.com:/fasta2a.git + +cd fasta2a + +```` + +Install uv (version 0.4.30 or later) + +### Running Lints and Tests etc + +````bash + +# Run linters +uv run scripts/check + +# Run unit tests +uv run scripts/test + +```` + +### Additional Questions + +If you have additional questions you can check out the #pydantic-ai channel in the Pydantic Slack to ask questions, get help, and chat about FastA2A. + From 49428100847c777e0bacc626b34765ab48ae729f Mon Sep 17 00:00:00 2001 From: Israel Ekpo Date: Fri, 11 Jul 2025 18:03:23 -0400 Subject: [PATCH 2/4] adding more areas of contribution --- CONTRIBUTORS.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index f745db2..854baf1 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -11,6 +11,8 @@ You can contribute to the project in the following areas: - reporting issues - making suggestions for feature requestions and improvements - starting and contributing to discussions +- reviewing pull requests +- responding to issues and discussions - creating examples and tutorials for the [FastA2A](https://ai.pydantic.dev/a2a/) project. Before reporting new issues, take a look at [existing issues](https://github.com/pydantic/fasta2a/issues) to ensure that you are not creating duplicates. From fdeb447c65c53c4393b95ce757f894ef760dba1a Mon Sep 17 00:00:00 2001 From: Israel Ekpo Date: Fri, 11 Jul 2025 18:10:00 -0400 Subject: [PATCH 3/4] fixing typos in the docs --- CONTRIBUTORS.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 854baf1..5e57480 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -19,7 +19,7 @@ Before reporting new issues, take a look at [existing issues](https://github.com ### Pre-Commit Checks before Sending in your Pull Requests -Clone for fork of the [FastA2A repo](https://github.com/pydantic/fasta2a/fork) and cd into that directory +Clone a fork of the [FastA2A repo](https://github.com/pydantic/fasta2a/fork) and cd into that directory ````bash @@ -33,6 +33,13 @@ Install uv (version 0.4.30 or later) ### Running Lints and Tests etc +Run the following commands before checking in your changes to git. + +Your PR may not be accepted if it fails these checks. + +It is usually a good idea to keep the branch in your fork up-to-date with the upstream branch if you are planning +to work on your changes over an extended period of time. + ````bash # Run linters From 8faee2daf60d22b8b9beadf9977132c01da367a9 Mon Sep 17 00:00:00 2001 From: Israel Ekpo Date: Tue, 15 Jul 2025 17:54:48 -0400 Subject: [PATCH 4/4] checking code review fixes for #18 --- CONTRIBUTORS.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 5e57480..e847788 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -9,7 +9,7 @@ You can contribute to the project in the following areas: - python code updates (adding functionality, fixing bugs, adding code documentation etc.) - writing new unit tests, fixing existing unit tests - reporting issues -- making suggestions for feature requestions and improvements +- making suggestions for feature requests and improvements - starting and contributing to discussions - reviewing pull requests - responding to issues and discussions @@ -21,13 +21,13 @@ Before reporting new issues, take a look at [existing issues](https://github.com Clone a fork of the [FastA2A repo](https://github.com/pydantic/fasta2a/fork) and cd into that directory -````bash +```bash git clone git@github.com:/fasta2a.git cd fasta2a -```` +``` Install uv (version 0.4.30 or later) @@ -38,9 +38,9 @@ Run the following commands before checking in your changes to git. Your PR may not be accepted if it fails these checks. It is usually a good idea to keep the branch in your fork up-to-date with the upstream branch if you are planning -to work on your changes over an extended period of time. +to work on your changes over an extended period of time. -````bash +```bash # Run linters uv run scripts/check @@ -48,7 +48,7 @@ uv run scripts/check # Run unit tests uv run scripts/test -```` +``` ### Additional Questions