sf-agent-framework/CONTRIBUTING.md

AI Agent Orchestration Framework for Salesforce Development - Two-phase architecture with 70% context reduction

# Contributing to the SF-Agent Framework

We welcome contributions to the SF-Agent Framework! This guide will help you get
started with the framework and make your first contribution.

## 1. Code of Conduct

We have a [Code of Conduct](CODE_OF_CONDUCT.md) that we expect all contributors
to adhere to. Please read it before contributing.

## 2. How to Contribute

There are many ways to contribute to the SF-Agent Framework. Here are a few
ideas:

- **Report bugs:** If you find a bug, please report it by creating an issue on
  our
  [GitHub repository](https://github.com/kripaSFDC/sf-agent-framework/issues).
- **Suggest new features:** If you have an idea for a new feature, please
  suggest it by creating an issue on our
  [GitHub repository](https://github.com/kripaSFDC/sf-agent-framework/issues).
- **Write documentation:** We're always looking for help with our documentation.
  If you're interested in writing documentation, please let us know.
- **Contribute code:** If you're a developer, you can contribute code to the
  framework. We have a list of open issues on our
  [GitHub repository](https://github.com/kripaSFDC/sf-agent-framework/issues)
  that you can work on.

## 3. Getting Started

To get started with the framework, you'll need to install it on your local
machine. You can do this by running the following command:

```bash
npm install -g sf-agent-framework
```

Once you have the framework installed, you can start making changes to the code.
When you're ready to submit your changes, you can create a pull request on our
[GitHub repository](https://github.com/kripaSFDC/sf-agent-framework/pulls).

## 4. Development Environment

To set up a development environment, you'll need to have Node.js and npm
installed on your machine. You can download them from the
[Node.js website](https://nodejs.org/).

Once you have Node.js and npm installed, you can clone the repository and
install the dependencies:

```bash
git clone https://github.com/kripaSFDC/sf-agent-framework.git
cd sf-agent-framework
npm install
```

Now you're ready to start developing!

## 5. Pull Request Process

1.  Fork the repository and create your branch from `main`.
2.  If you've added code that should be tested, add tests.
3.  If you've changed APIs, update the documentation.
4.  Ensure the test suite passes.
5.  Make sure your code lints.
6.  Issue that pull request!

## 6. Code of Conduct

### Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of
experience, education, socio-economic status, nationality, personal appearance,
race, religion, or sexual identity and orientation.

### Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
  advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
  address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
  professional setting

### Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.

### Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an
incident. Further details of specific enforcement policies may be posted
separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

### Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For something more specific to your project, you might want to add details about
your branching strategy, coding style, and how to run tests.