diff --git a/integrations/.DS_Store b/integrations/.DS_Store deleted file mode 100644 index efd62c47..00000000 Binary files a/integrations/.DS_Store and /dev/null differ diff --git a/integrations/CONTRIBUTING.md b/integrations/CONTRIBUTING.md new file mode 100644 index 00000000..e87b7197 --- /dev/null +++ b/integrations/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing + +Contributions to integrations are welcome 😊 the integrations repo is the place where you can share how you've integrated uAgents with other technology. + +## A few simple rules + +- Search the repo for the integration you're submitting, just in case. + +- run [black](https://pypi.org/project/black/) on your code before submitting. + +- Include a `project.json` file, example of: + +```js +{ + "title": "Bert Base Uncased", + "description": "BERT base model (uncased) Pretrained model on English language using a masked language modeling (MLM) objective.", + "categories": ["Text Classification", "Hugging Face", "Text Generation"], + "deltav": false +} +``` + +Set deltav to true if your agent is built using agentverse and is accessible by DeltaV. + +## Commits and PRs + +This project uses Conventional Commits to generate release notes and to determine versioning. Commit messages should adhere to this standard and be of the form: + +You will need to fork uAgents and then clone the repo to make PRs to this project. Please be descriptive in your commits: + +```bash +git commit -m "feat: add new feature x" +git commit -m "fix: fix bug in feature x" +git commit -m "docs: add documentation for feature x" +git commit -m "test: add test suite for feature x" +``` + +Further details on `conventional commits` can be found here: + + +## Support and help + +Suppport and extra information is available in our [documentation](https://fetch.ai/docs) and on [Discord](https://discord.com/invite/fetchai)