chore: contribution guides

AUTHORS.md

@@ -0,0 +1,6 @@
+# Authors
+
+* [Utkarsh Dixit](https://github.com/utkarsh-dixit) <utkarsh@composio.dev>
+* [Sawardip Saha](https://github.com/sawradip) <swaradip@composio.dev>
+* [Soham Ganatra](https://github.com/sohamganatra) <soham@composio.dev>
+* [Karan Vaidya](https://github.com/kaavee315) <karan@composio.dev>

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant 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, sex characteristics, 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 behaviour 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 behaviour 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
+behaviour and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behaviour.
+
+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 behaviours 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 behaviour may be
+reported by contacting the project team at <developer@composio.dev>. 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 answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Contributions to the framework, its plugins, related tools and tools are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
+
+There are various ways to contribute:
+
+- If you need support, want to report a bug or ask for features, you can check the [Issues page](https://github.com/SamparkAI/composio/issues) and raise an issue, if applicable.
+- If you would like to contribute a bug fix of feature then [Submit a pull request](https://github.com/SamparkAI/composio/pulls).
+- If you have other kinds of feedback, you can contact one of the [authors](https://github.com/SamparkAI/composio/blob/main/AUTHORS.md) by email.
+
+> Before reading on, please have a look at the [code of conduct](https://github.com/SamparkAI/composio/blob/main/CODE_OF_CONDUCT.md).
+
+## A few simple rules
+
+- Before working on a feature, reach out to one of the core developers or discuss the feature in an issue. The framework caters a diverse audience and new features require upfront coordination.
+- Include unit tests for 100% coverage if possible when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost.
+- Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage.
+- Keep API compatibility in mind when you change code in the `composio`. Although `composio` is does not have a LTS release yet there are a lot of downstream dependencies which would be affected by a breaking changes, so if there are any breaking changes on your PR try to maintain backwards compatibility by introducing a [deprecation warning](https://github.com/SamparkAI/composio_sdk/blob/495cd0d8a644ee84e3f7ee4a6ab6907594895efe/composio/utils/decorators.py#L15) on the existing API and discussing the breaking changes with maintainers.
+- When you contribute a new feature to `composio`, the maintenance burden is transferred to the core team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature.
+- Before committing and opening a PR, run all tests locally. This saves CI hours and ensures you only commit clean code.
+
+## Contributing code
+
+If you have improvements, send us your pull requests!
+
+A team member will be assigned to review your pull requests. All tests are run as part of CI as well as various other checks (code formatting, linters, static type checkers, etc). If there are any problems, feedback is provided via GitHub. Once the pull requests is approved and passes continuous integration checks, you or a team member can merge it.
+
+If you want to contribute, start working through the codebase, navigate to the Github `issues` tab and start looking through interesting issues. If you are not sure of where to start, then start by trying one of the smaller/easier issues here i.e. issues with the `good first issue` label and then take a look at the issues with the `contributions welcome` label. These are issues that we believe are particularly well suited for outside contributions, often because we probably won't get to them right now. If you decide to start on an issue, leave a comment so that other people know that you're working on it. If you want to help out, but not alone, use the issue comment thread to coordinate.
+
+## Development setup
+
+- The simplest way to get setup for development on the framework is to install Python `>=3.8` and `pipenv`, then run the following:
+
+      make env
+      pipenv shell
+
+##  For a clean PR run checks in the following order before pushing the code on a PR
+
+- make clean
+- make format-code
+- make check-code
+
+## Further commands needed during development
+
+We have various commands which are helpful during development.
+
+- For independent linting and static analysis:
+  - Use `tox -e isort` and `tox -e black` for formatting code
+  - Use `tox -e isort-check` and `tox -e black-check` for checking code formatting
+  - Use `tox -e flake8` and `tox -e pylint` to run code linters
+  - Use `tox -e mypy` for type checking