chore: update CONTRIBUTING.md

[0xRAG]

Summary

This PR updates the contributing guide. It adds a high-level generic guide, as well as two language specific guides – one for Python and one for TypeScript

[cb-heimdall]

✅ Heimdall Review Status

Requirement	Status	More Info
Reviews	✅ 1/1	Denominator calculation Show calculation 1 if user is bot 0 1 if user is external 0 From .codeflow.yml 1 Additional review requirements Show calculation Max 0 0 From CODEOWNERS 0 Global minimum 0 Max 1 1 1 if commit is unverified 0 Sum 1

[John-peterson-coinbase]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

[murrlincoln]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

I agree this would make the most sense - if we put this in the main docs (I'd like to) then we can put it hidden beneath tabs but for this style of documentation it seems to make sense to separate them both

[murrlincoln]

Thoughts about putting a context section here or some sort of link out to CDP SDK for those using contract invocations? Want to prevent issues where someone uses an API or something that is an unnecessary dependency/requires each user to provision API keys (where possible. If there's no other option that's fine but we can't include it as a default tool)

[murrlincoln]

May not be appropriate for this pass, but at some point it would be great to define how we want contributors to integrate AgentKit into new frameworks. Some of the prizes for the SF AI hackathon reward for this.

Main goal being to prevent a framework user from having to do anything but import the latest package for agentkit to get all of the most recent features and capabilities

[murrlincoln]

see comments

[John-peterson-coinbase]

Let's continue to iterate here. Merging so we can receive feedback

[0xRAG]

Summary

This PR updates the contributing guide. It adds a high-level generic guide, as well as two language specific guides – one for Python and one for TypeScript

[cb-heimdall]

✅ Heimdall Review Status

Requirement	Status	More Info
Reviews	✅ 1/1	Denominator calculation Show calculation 1 if user is bot 0 1 if user is external 0 From .codeflow.yml 1 Additional review requirements Show calculation Max 0 0 From CODEOWNERS 0 Global minimum 0 Max 1 1 1 if commit is unverified 0 Sum 1

[John-peterson-coinbase]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

[murrlincoln]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

I agree this would make the most sense - if we put this in the main docs (I'd like to) then we can put it hidden beneath tabs but for this style of documentation it seems to make sense to separate them both

[murrlincoln]

Thoughts about putting a context section here or some sort of link out to CDP SDK for those using contract invocations? Want to prevent issues where someone uses an API or something that is an unnecessary dependency/requires each user to provision API keys (where possible. If there's no other option that's fine but we can't include it as a default tool)

[murrlincoln]

May not be appropriate for this pass, but at some point it would be great to define how we want contributors to integrate AgentKit into new frameworks. Some of the prizes for the SF AI hackathon reward for this.

Main goal being to prevent a framework user from having to do anything but import the latest package for agentkit to get all of the most recent features and capabilities

[murrlincoln]

see comments

[John-peterson-coinbase]

Let's continue to iterate here. Merging so we can receive feedback

[0xRAG]

Summary

This PR updates the contributing guide. It adds a high-level generic guide, as well as two language specific guides – one for Python and one for TypeScript

[cb-heimdall]

✅ Heimdall Review Status

Requirement	Status	More Info
Reviews	✅ 1/1	Denominator calculation Show calculation 1 if user is bot 0 1 if user is external 0 From .codeflow.yml 1 Additional review requirements Show calculation Max 0 0 From CODEOWNERS 0 Global minimum 0 Max 1 1 1 if commit is unverified 0 Sum 1

[John-peterson-coinbase]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

[murrlincoln]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

I agree this would make the most sense - if we put this in the main docs (I'd like to) then we can put it hidden beneath tabs but for this style of documentation it seems to make sense to separate them both

[murrlincoln]

Thoughts about putting a context section here or some sort of link out to CDP SDK for those using contract invocations? Want to prevent issues where someone uses an API or something that is an unnecessary dependency/requires each user to provision API keys (where possible. If there's no other option that's fine but we can't include it as a default tool)

[murrlincoln]

May not be appropriate for this pass, but at some point it would be great to define how we want contributors to integrate AgentKit into new frameworks. Some of the prizes for the SF AI hackathon reward for this.

Main goal being to prevent a framework user from having to do anything but import the latest package for agentkit to get all of the most recent features and capabilities

[murrlincoln]

see comments

[John-peterson-coinbase]

Let's continue to iterate here. Merging so we can receive feedback

[0xRAG]

Summary

This PR updates the contributing guide. It adds a high-level generic guide, as well as two language specific guides – one for Python and one for TypeScript

[cb-heimdall]

✅ Heimdall Review Status

Requirement	Status	More Info
Reviews	✅ 1/1	Denominator calculation Show calculation 1 if user is bot 0 1 if user is external 0 From .codeflow.yml 1 Additional review requirements Show calculation Max 0 0 From CODEOWNERS 0 Global minimum 0 Max 1 1 1 if commit is unverified 0 Sum 1

[John-peterson-coinbase]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

[murrlincoln]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

I agree this would make the most sense - if we put this in the main docs (I'd like to) then we can put it hidden beneath tabs but for this style of documentation it seems to make sense to separate them both

[murrlincoln]

Thoughts about putting a context section here or some sort of link out to CDP SDK for those using contract invocations? Want to prevent issues where someone uses an API or something that is an unnecessary dependency/requires each user to provision API keys (where possible. If there's no other option that's fine but we can't include it as a default tool)

[murrlincoln]

May not be appropriate for this pass, but at some point it would be great to define how we want contributors to integrate AgentKit into new frameworks. Some of the prizes for the SF AI hackathon reward for this.

Main goal being to prevent a framework user from having to do anything but import the latest package for agentkit to get all of the most recent features and capabilities

[murrlincoln]

see comments

[John-peterson-coinbase]

Let's continue to iterate here. Merging so we can receive feedback

[0xRAG]

Summary

This PR updates the contributing guide. It adds a high-level generic guide, as well as two language specific guides – one for Python and one for TypeScript

[cb-heimdall]

✅ Heimdall Review Status

Requirement	Status	More Info
Reviews	✅ 1/1	Denominator calculation Show calculation 1 if user is bot 0 1 if user is external 0 From .codeflow.yml 1 Additional review requirements Show calculation Max 0 0 From CODEOWNERS 0 Global minimum 0 Max 1 1 1 if commit is unverified 0 Sum 1

[John-peterson-coinbase]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

[murrlincoln]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

I agree this would make the most sense - if we put this in the main docs (I'd like to) then we can put it hidden beneath tabs but for this style of documentation it seems to make sense to separate them both

[murrlincoln]

Thoughts about putting a context section here or some sort of link out to CDP SDK for those using contract invocations? Want to prevent issues where someone uses an API or something that is an unnecessary dependency/requires each user to provision API keys (where possible. If there's no other option that's fine but we can't include it as a default tool)

[murrlincoln]

May not be appropriate for this pass, but at some point it would be great to define how we want contributors to integrate AgentKit into new frameworks. Some of the prizes for the SF AI hackathon reward for this.

Main goal being to prevent a framework user from having to do anything but import the latest package for agentkit to get all of the most recent features and capabilities

[murrlincoln]

see comments

[John-peterson-coinbase]

Let's continue to iterate here. Merging so we can receive feedback

[0xRAG]

Summary

This PR updates the contributing guide. It adds a high-level generic guide, as well as two language specific guides – one for Python and one for TypeScript

[cb-heimdall]

✅ Heimdall Review Status

Requirement	Status	More Info
Reviews	✅ 1/1	Denominator calculation Show calculation 1 if user is bot 0 1 if user is external 0 From .codeflow.yml 1 Additional review requirements Show calculation Max 0 0 From CODEOWNERS 0 Global minimum 0 Max 1 1 1 if commit is unverified 0 Sum 1

[John-peterson-coinbase]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

[murrlincoln]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

I agree this would make the most sense - if we put this in the main docs (I'd like to) then we can put it hidden beneath tabs but for this style of documentation it seems to make sense to separate them both

[murrlincoln]

Thoughts about putting a context section here or some sort of link out to CDP SDK for those using contract invocations? Want to prevent issues where someone uses an API or something that is an unnecessary dependency/requires each user to provision API keys (where possible. If there's no other option that's fine but we can't include it as a default tool)

[murrlincoln]

May not be appropriate for this pass, but at some point it would be great to define how we want contributors to integrate AgentKit into new frameworks. Some of the prizes for the SF AI hackathon reward for this.

Main goal being to prevent a framework user from having to do anything but import the latest package for agentkit to get all of the most recent features and capabilities

[murrlincoln]

see comments

[John-peterson-coinbase]

Let's continue to iterate here. Merging so we can receive feedback

[0xRAG]

Summary

This PR updates the contributing guide. It adds a high-level generic guide, as well as two language specific guides – one for Python and one for TypeScript

[cb-heimdall]

✅ Heimdall Review Status

Requirement	Status	More Info
Reviews	✅ 1/1	Denominator calculation Show calculation 1 if user is bot 0 1 if user is external 0 From .codeflow.yml 1 Additional review requirements Show calculation Max 0 0 From CODEOWNERS 0 Global minimum 0 Max 1 1 1 if commit is unverified 0 Sum 1

[John-peterson-coinbase]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

[murrlincoln]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

I agree this would make the most sense - if we put this in the main docs (I'd like to) then we can put it hidden beneath tabs but for this style of documentation it seems to make sense to separate them both

[murrlincoln]

Thoughts about putting a context section here or some sort of link out to CDP SDK for those using contract invocations? Want to prevent issues where someone uses an API or something that is an unnecessary dependency/requires each user to provision API keys (where possible. If there's no other option that's fine but we can't include it as a default tool)

[murrlincoln]

May not be appropriate for this pass, but at some point it would be great to define how we want contributors to integrate AgentKit into new frameworks. Some of the prizes for the SF AI hackathon reward for this.

Main goal being to prevent a framework user from having to do anything but import the latest package for agentkit to get all of the most recent features and capabilities

[murrlincoln]

see comments

[John-peterson-coinbase]

Let's continue to iterate here. Merging so we can receive feedback

[0xRAG]

Summary

This PR updates the contributing guide. It adds a high-level generic guide, as well as two language specific guides – one for Python and one for TypeScript

[cb-heimdall]

✅ Heimdall Review Status

Requirement	Status	More Info
Reviews	✅ 1/1	Denominator calculation Show calculation 1 if user is bot 0 1 if user is external 0 From .codeflow.yml 1 Additional review requirements Show calculation Max 0 0 From CODEOWNERS 0 Global minimum 0 Max 1 1 1 if commit is unverified 0 Sum 1

[John-peterson-coinbase]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

[murrlincoln]

I question if we should have the steps interlaced with Python and Typescript. I imagine a developer will follow the complete contribution guide top to bottom in 1 language (they may then go to the other language, but it is not required). There is a high level of focus required to go through the full doc and only parse out the Python sections for example without missing any.

It might be best to split into sub-documents for python and typescript. The top level doc can give higher level advice such as how to discuss a feature request / bug via GH Issue, PR review triage and SLA, etc..

cc: @murrlincoln for thoughts

I agree this would make the most sense - if we put this in the main docs (I'd like to) then we can put it hidden beneath tabs but for this style of documentation it seems to make sense to separate them both

[murrlincoln]

Thoughts about putting a context section here or some sort of link out to CDP SDK for those using contract invocations? Want to prevent issues where someone uses an API or something that is an unnecessary dependency/requires each user to provision API keys (where possible. If there's no other option that's fine but we can't include it as a default tool)

[murrlincoln]

May not be appropriate for this pass, but at some point it would be great to define how we want contributors to integrate AgentKit into new frameworks. Some of the prizes for the SF AI hackathon reward for this.

Main goal being to prevent a framework user from having to do anything but import the latest package for agentkit to get all of the most recent features and capabilities

[murrlincoln]

see comments

[John-peterson-coinbase]

Let's continue to iterate here. Merging so we can receive feedback