From 517b1c1b72dcc5f6477df9fe7e7f9e382ae35b38 Mon Sep 17 00:00:00 2001 From: B-DeshiDev Date: Tue, 2 Apr 2024 17:59:54 +0600 Subject: [PATCH] Extra docs --- CONTRIBUTING.md | 38 ++++++++++++++++++++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 42 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0233736 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,38 @@ +# Contributing to Dialogue System package. + +Thank you for your interest in contributing. We welcome and appreciate any contributions, whether it is +code, documentation, bug reports, feature requests, or general feedback. + +## How to Contribute + +There are many ways you can contribute to this project. Here are some guidelines to help you get started. + +### Reporting Issues + +If you encounter any problems or have any suggestions for improvement, please open an issue on GitHub. Be as descriptive as possible and include any relevant information such as error messages, +screenshots, or steps to reproduce the issue. + +### Submitting Pull Requests + +If you want to contribute code or documentation to this project, you can submit a pull request (PR) on GitHub. Before +you do so, please make sure that: + +- You have tested your code locally and ensured that it works as expected (also be sure you have added tests). +- You have written clear and concise commit messages and PR descriptions. +- You have updated the documentation if necessary. +- You have resolved any merge conflicts with the main branch. + +To submit a PR, follow these steps: + +1. Fork the repository and create a new branch from the main branch. +2. Make your changes and commit them with a meaningful message. +3. Push your branch to your forked repository on GitHub. +4. Create a PR from your branch to the main branch of the original repository. +5. Wait for the project maintainers to review your PR and provide feedback or approval. +6. If requested, make any necessary changes and update your PR accordingly. + + +## Thank You + +We appreciate your time and effort in contributing to this project. We hope you enjoy using BTSM and find it +useful. Thank you for being part of our community! diff --git a/README.md b/README.md index 31ffc33..7ff5bb6 100644 --- a/README.md +++ b/README.md @@ -34,3 +34,7 @@ https://github.com/Studio-23-xyz/com.studio23.ss2.dialoguesystem.git#upm 4. Implement your own Dialogue UI as per need. (Check Samples for demonstration) +# Contribution +https://github.com/Studio-23-xyz/com.studio23.ss2.dialoguesystem/blob/main/CONTRIBUTING.md + +