Skip to content

Commit

Permalink
Beta version in cookiecutter and added to contributing guide (#908)
Browse files Browse the repository at this point in the history
# Description

What - Made CookieCutter version beta, and added explanation to the
contributing guide

## Type of change

Please leave one option from the following and delete the rest:

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] New Integration (non-breaking change which adds a new integration)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [X] Non-breaking change (fix of existing functionality that will not
change current behavior)
- [X] Documentation (added/updated documentation)

## Screenshots

Include screenshots from your environment showing how the resources of
the integration will look.

## API Documentation

Provide links to the API documentation used for this integration.

---------

Co-authored-by: Tom Tankilevitch <[email protected]>
  • Loading branch information
omby8888 and Tankilevitch authored Aug 15, 2024
1 parent 782612e commit f9327ab
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Apart from contributing to the framework itself, you can also contribute by addi

3. **Testing and Documentation**: Thoroughly test the integration to ensure its reliability and functionality. Additionally, document the integration by providing usage instructions, configuration details, and any specific considerations users should be aware of.

4. **Integration Submission**: Finally, submit your integration code and documentation to the framework's repository for review. Collaborate with other contributors to address feedback and make any necessary improvements.
4. **Integration Submission**: Finally, submit your integration code and documentation to the framework's repository for review. Collaborate with other contributors to address feedback and make any necessary improvements. Ensure that the integration is submitted as a `beta` version. This allows for a period of testing and feedback, ensuring that any potential issues can be identified and addressed before the integration is released as GA.

By contributing a new integration, you enable users of the framework to seamlessly integrate with additional data sources and services, expanding its versatility and usefulness.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "{{cookiecutter.integration_slug}}"
version = "0.1.0"
version = "0.1.0-beta"
description = "{{cookiecutter.integration_short_description}}"
authors = ["{{cookiecutter.full_name}} <{{cookiecutter.email}}>"]

Expand Down

0 comments on commit f9327ab

Please sign in to comment.