Skip to content

Commit

Permalink
[add] licence and contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
tuancamtbtx committed Dec 4, 2023
1 parent 4fec70c commit 0033278
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 1 deletion.
37 changes: 37 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Contributing to [Project Name]

Thank you for your interest in contributing to our project! Please take a moment to review the following guidelines.

## How to Contribute

1. Fork the repository
2. Create a new branch for your feature or fix: `git checkout -b feature-branch-name`
3. Make your changes and commit them: `git commit -m 'Description of your changes'`
4. Push to your branch: `git push origin feature-branch-name`
5. Submit a pull request

## Code Style

We follow the [style guide](link to style guide) for our project. Please ensure your code adheres to this style.

## Reporting Bugs

To report a bug, open an issue on the GitHub repository and include a detailed description of the problem.

## Suggesting Enhancements

If you have an idea for an enhancement, feel free to open an issue to discuss it.

## Code of Conduct

Please review and adhere to our [Code of Conduct](link to code of conduct) in all interactions.

## License

By contributing to this project, you agree that your contributions will be licensed under the [project license](LICENSE).

We appreciate your help in making our project better!

For questions or clarifications, please reach out to [maintainer's name and email].
This example provides a basic template for a CONTRIBUTING.md file, outlining guidelines for contributing to a project on GitHub. You can customize this template to fit the specific requirements and processes of your project.

21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Tuan Nguyen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,7 @@ Follow via https://debezium.io/documentation/reference/stable/operations/debeziu

### Architecture
![alt text](./images/cdc_debezium_server.gif)

## Contributing
The project has a separate contribution file. Please adhere to the steps listed in the separate contributions [file](./CONTRIBUTING.md)
## License
[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)

0 comments on commit 0033278

Please sign in to comment.