Skip to content

Commit b89a245

Browse files
fjumafjuma
authored
Merge pull request #116 from fjuma/spec
Add LICENSE, SECURITY.md, CONTRIBUTING.md, and CODE_OF_CONDUCT.md
2 parents 2981235 + 1610acf commit b89a245

File tree

5 files changed

+460
-0
lines changed

5 files changed

+460
-0
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement:
63+
64+
Farah Juma - [email protected] \
65+
Kabir Khan - [email protected] \
66+
Stefano Maestri - [email protected] \
67+
68+
All complaints will be reviewed and investigated promptly and fairly.
69+
70+
All community leaders are obligated to respect the privacy and security of the
71+
reporter of any incident.
72+
73+
## Enforcement Guidelines
74+
75+
Community leaders will follow these Community Impact Guidelines in determining
76+
the consequences for any action they deem in violation of this Code of Conduct:
77+
78+
### 1. Correction
79+
80+
**Community Impact**: Use of inappropriate language or other behavior deemed
81+
unprofessional or unwelcome in the community.
82+
83+
**Consequence**: A private, written warning from community leaders, providing
84+
clarity around the nature of the violation and an explanation of why the
85+
behavior was inappropriate. A public apology may be requested.
86+
87+
### 2. Warning
88+
89+
**Community Impact**: A violation through a single incident or series of
90+
actions.
91+
92+
**Consequence**: A warning with consequences for continued behavior. No
93+
interaction with the people involved, including unsolicited interaction with
94+
those enforcing the Code of Conduct, for a specified period of time. This
95+
includes avoiding interactions in community spaces as well as external channels
96+
like social media. Violating these terms may lead to a temporary or permanent
97+
ban.
98+
99+
### 3. Temporary Ban
100+
101+
**Community Impact**: A serious violation of community standards, including
102+
sustained inappropriate behavior.
103+
104+
**Consequence**: A temporary ban from any sort of interaction or public
105+
communication with the community for a specified period of time. No public or
106+
private interaction with the people involved, including unsolicited interaction
107+
with those enforcing the Code of Conduct, is allowed during this period.
108+
Violating these terms may lead to a permanent ban.
109+
110+
### 4. Permanent Ban
111+
112+
**Community Impact**: Demonstrating a pattern of violation of community
113+
standards, including sustained inappropriate behavior, harassment of an
114+
individual, or aggression toward or disparagement of classes of individuals.
115+
116+
**Consequence**: A permanent ban from any sort of public interaction within the
117+
community.
118+
119+
## Attribution
120+
121+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
122+
version 2.1, available at
123+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
124+
125+
Community Impact Guidelines were inspired by
126+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
127+
128+
For answers to common questions about this code of conduct, see the FAQ at
129+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
130+
[https://www.contributor-covenant.org/translations][translations].
131+
132+
[homepage]: https://www.contributor-covenant.org
133+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
134+
[Mozilla CoC]: https://github.com/mozilla/diversity
135+
[FAQ]: https://www.contributor-covenant.org/faq
136+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
Contributing to a2a-java-sdk
2+
==================================
3+
4+
Welcome to the A2A Java SDK project! We welcome contributions from the community. This guide will walk you through the steps for getting started on our project.
5+
6+
- [Forking the Project](#forking-the-project)
7+
- [Issues](#issues)
8+
- [Good First Issues](#good-first-issues)
9+
- [Setting up your Developer Environment](#setting-up-your-developer-environment)
10+
- [Contributing Guidelines](#contributing-guidelines)
11+
- [Community](#community)
12+
13+
14+
## Forking the Project
15+
To contribute, you will first need to fork the [a2a-java-sdk](https://github.com/fjuma/a2a-java-sdk) repository.
16+
17+
This can be done by looking in the top-right corner of the repository page and clicking "Fork".
18+
![fork](images/fork.jpg)
19+
20+
The next step is to clone your newly forked repository onto your local workspace. This can be done by going to your newly forked repository, which should be at `https://github.com/USERNAME/a2a-java-sdk`.
21+
22+
Then, there will be a green button that says "Code". Click on that and copy the URL.
23+
24+
Then, in your terminal, paste the following command:
25+
```bash
26+
git clone [URL]
27+
```
28+
Be sure to replace [URL] with the URL that you copied.
29+
30+
Now you have the repository on your computer!
31+
32+
## Issues
33+
The `a2a-java-sdk` project uses GitHub to manage issues. All issues can be found [here](https://github.com/fjuma/a2a-java-sdk/issues).
34+
35+
To create a new issue, comment on an existing issue, or assign an issue to yourself, you'll need to first [create a GitHub account](https://github.com/).
36+
37+
38+
### Good First Issues
39+
Want to contribute to the a2a-java-sdk project but aren't quite sure where to start? Check out our issues with the `good-first-issue` label. These are a triaged set of issues that are great for getting started on our project. These can be found [here](https://github.com/fjuma/a2a-java-sdk/labels/good%20first%20issue).
40+
41+
Once you have selected an issue you'd like to work on, make sure it's not already assigned to someone else, and assign it to yourself.
42+
43+
It is recommended that you use a separate branch for every issue you work on. To keep things straightforward and memorable, you can name each branch using the GitHub issue number. This way, you can have multiple PRs open for different issues. For example, if you were working on [issue-20](https://github.com/fjuma/a2a-java-sdk/issues/20), you could use `issue-20` as your branch name.
44+
45+
## Setting up your Developer Environment
46+
You will need:
47+
48+
* Java 17+
49+
* Git
50+
* An IDE (e.g., IntelliJ IDEA, Eclipse, VSCode, etc.)
51+
52+
To set up your development environment you need to:
53+
54+
1. First `cd` to the directory where you cloned the project (eg: `cd a2a-java-sdk`)
55+
56+
2. Add a remote ref to upstream, for pulling future updates. For example:
57+
58+
```
59+
git remote add upstream https://github.com/fjuma/a2a-java-sdk
60+
```
61+
62+
3. To build `a2a-java-sdk` and run the tests, use the following command:
63+
64+
```
65+
mvn clean install
66+
```
67+
68+
4. To skip the tests:
69+
70+
```
71+
mvn clean install -DskipTests=true
72+
```
73+
74+
## Contributing Guidelines
75+
76+
When submitting a PR, please keep the following guidelines in mind:
77+
78+
1. In general, it's good practice to squash all of your commits into a single commit. For larger changes, it's ok to have multiple meaningful commits. If you need help with squashing your commits, feel free to ask us how to do this on your pull request. We're more than happy to help!
79+
80+
2. Please link the issue you worked on in the description of your pull request and in your commit message. For example, for issue-20, the PR description and commit message could be: ```Add tests to A2AClientTest for sending a task with a FilePart and with a DataPart
81+
Fixes #20```
82+
83+
3. Your PR should include tests for the functionality that you are adding.
84+
85+
4. Your PR should include appropriate [documentation](https://github.com/fjuma/a2a-java-sdk/blob/main/README.md) for the functionality that you are adding.
86+
87+
## Code Reviews
88+
89+
All submissions, including submissions by project members, need to be reviewed by at least one `a2a-java-sdk` committer before being merged.
90+
91+
The [GitHub Pull Request Review Process](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews) is followed for every pull request.

0 commit comments

Comments
 (0)