From e3e21840cfeadbd9dbd663e0b6009618120c3e9d Mon Sep 17 00:00:00 2001
From: Emi <2206700+coppolaemilio@users.noreply.github.com>
Date: Sun, 9 Jun 2024 13:11:32 +0200
Subject: [PATCH] Add contributing page
---
documentation/SUMMARY.md | 1 +
documentation/contributing.md | 64 +++++++++++++++++++++++++++++++++++
2 files changed, 65 insertions(+)
create mode 100644 documentation/contributing.md
diff --git a/documentation/SUMMARY.md b/documentation/SUMMARY.md
index b908686..f69c0e4 100644
--- a/documentation/SUMMARY.md
+++ b/documentation/SUMMARY.md
@@ -132,3 +132,4 @@
- [Util](classes/class_dialogicutil.md)
- [VisualEditorField](classes/class_dialogicvisualeditorfield.md)
+[Contributing](contributing.md)
\ No newline at end of file
diff --git a/documentation/contributing.md b/documentation/contributing.md
new file mode 100644
index 0000000..fe40875
--- /dev/null
+++ b/documentation/contributing.md
@@ -0,0 +1,64 @@
+
+
+We develop the Dialogic plugin in the open at [GitHub](https://github.com/dialogic-godot).
+The main [dialogic](https://github.com/dialogic-godot/dialogic) repository that contains all the code, images, and logic for the plugin, and this documentation is stored in the [documentation](https://github.com/dialogic-godot/documentation) repository. You will find other repositories such as the [Godot 3 version of Dialogic](https://github.com/dialogic-godot/dialogic-1), a [test project](https://github.com/dialogic-godot/test-project), a [visual novel template](https://github.com/dialogic-godot/visual-novel-template), extensions and more.
+
+## How to contribute
+
+There are different ways to contribute to Dialogic. You could be a developer, a designer, a writer, or a user who wants to help improve the project. Here are some ways you can contribute:
+- [Reporting bugs](#reporting-bugs)
+- [Creating pull requests](#creating-pull-requests)
+- [Answering questions](#answering-questions)
+- [Donating](#donate)
+
+
+### Reporting bugs
+While working on your project, you might encounter a bug or come up with an idea for a new feature that could benefit the Dialogic community. If you believe this improvement or bug fix would be valuable to the majority of users, it is a good candidate for an issue. Dialogic and Godot are designed to be flexible and extensible, so it is better to remain agnostic to specific game requirements. Before creating a new issue, consider the following steps to help us improve Dialogic:
+
+- **Search for Similar Issues:** Use the [search function](https://github.com/dialogic-godot/dialogic/issues) on GitHub to enter keywords related to your identified issue. This helps you see if someone has already reported it.
+- **Review Existing Issues:** Go through the [list of existing issues](https://github.com/dialogic-godot/dialogic/issues) to check if your issue is already documented. If it is, consider contributing to the discussion or offering to help resolve it instead of creating a new one.
+
+If your issue doesn’t exist, create it by pressing on the "New issue" button or by visiting [this page](https://github.com/dialogic-godot/dialogic/issues/new/choose). Remember to describe the issue in detail, including steps to reproduce it if it's a bug, the version of Godot and Dialogic you are using, or explaining why the new feature is beneficial. If it is a bug, it is extremely helpful to include a minimal code example that reproduces the issue, such as a small Godot+Dialogic project demonstrating the problem. This helps maintainers quickly identify the cause of the issue and fix it.
+
+Sure, here’s a more polished section on creating a pull request:
+
+### Creating Pull Requests
+
+If you have identified an existing issue and want to contribute a fix or enhancement, follow these steps to create a pull request:
+
+1. **Fork the Repository:** Click the "Fork" button on the top right of the repository page. This will create a copy of the repository in your GitHub account.
+2. **Clone the Repository:** Click the "Code" button and copy the URL. Then, in your terminal, run:
+ ```bash
+ git clone
+ ```
+3. **Create a New Branch:** Navigate to the repository directory on your local machine and create a new branch for your changes:
+ ```bash
+ git checkout -b
+ ```
+4. **Make Your Changes:** Edit the files in the repository to implement your fix or enhancement.
+5. **Commit Your Changes:** Stage and commit your changes with a descriptive message:
+ ```bash
+ git add .
+ git commit -m "Your message here"
+ ```
+6. **Push Your Changes:** Push your changes to your forked repository:
+ ```bash
+ git push origin
+ ```
+7. **Create a Pull Request:** Go to the repository page on GitHub and click the "New pull request" button. Select the correct branches and provide a detailed description of your changes, referencing the issue you are addressing.
+
+If you find using the terminal challenging, you can also use the [GitHub Desktop](https://desktop.github.com/) app or another graphical git client to manage your changes. These tools offer an easier interface for working with git, allowing you to focus more on your contributions rather than command-line operations.
+
+After submitting your pull request, monitor it for any comments or feedback from the project maintainers. If revisions are required, make the necessary changes based on their feedback and push the updates to your branch; your pull request will be automatically updated. Engage politely with reviewers, thank them for their feedback, and ask for clarification if needed. Remember, we are all volunteers working together to improve the project for everyone, so it's important to maintain a positive and collaborative atmosphere.
+
+
+### Answering questions
+
+Answering questions is another valuable way to contribute to the Dialogic community. You can help by participating in our [GitHub Discussions page](https://github.com/dialogic-godot/dialogic/discussions) and our [Discord server](https://discord.com/invite/DjcDgDaTMe), where users frequently ask questions about using the plugin, troubleshooting issues, or seeking advice on best practices.
+
+
+### Donating
+
+If you like Dialogic and want to support its development, you can donate to the project via [Patreon](https://www.patreon.com/coppolaemilio), or [Ko-fi](https://ko-fi.com/coppolaemilio). Your support is greatly appreciated and helps to keep the project going!
\ No newline at end of file