Skip to content

Commit

Permalink
Extra docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BDeshiDev committed Apr 2, 2024
1 parent c8b2142 commit 517b1c1
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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!
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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


0 comments on commit 517b1c1

Please sign in to comment.