fix: contributor, pull request and config document changes

Configuration Page - Documentation Update
onesoft-sudo · Nov 1, 2024 · e20c647 · e20c647
2 parents c2e8b48 + 061e8b7
commit e20c647
Show file tree

Hide file tree

Showing 3 changed files with 121 additions and 5 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,58 @@
+# Contributing to SudoBot
+
+Thank you for your interest in contributing to SudoBot! We appreciate any help to improve the project, whether through bug fixes, feature additions, documentation updates, or other improvements. Please review these guidelines to make your contribution process smooth and efficient.
+
+---
+
+## How to Contribute
+
+### 1. Reporting Bugs
+If you find a bug in SudoBot:
+
+- **Check for Existing Issues**: Look through open [Issues](https://github.com/onesoft-sudo/sudobot/issues) to see if the bug has already been reported.
+- **Create a New Issue**: If the bug hasn’t been reported, open a new issue with a clear title and description. Follow the proper issue template for specific instructions.
+
+### 2. Suggesting Features
+If you have an idea for a new feature:
+
+- **Search for Similar Feature Requests**: Review open issues to see if the feature has already been suggested.
+- **Submit a Feature Request**: If your idea is new, open a feature request issue and describe the functionality, use case, and any examples of expected behavior.
+
+### 3. Submitting a Pull Request
+When you're ready to contribute code:
+
+1. **Fork the Repository**: Use the “Fork” button at the top of the repository to create a personal copy of SudoBot.
+2. **Create a New Branch**: Work in a separate branch for your change. Use descriptive branch names (e.g., `fix-typo-in-docs` or `add-moderation-feature`).
+3. **Make Your Changes**: Follow the project’s code style, ensure your changes are well-documented, and update relevant tests.
+4. **Run Tests**: Verify your changes by running tests locally. For major changes, add new tests if necessary.
+5. **Submit a Pull Request**:
+   - Go to your forked repository and open a pull request (PR) against the main SudoBot repository.
+   - Follow the [Pull Request Template](.github/PULL_REQUEST_TEMPLATE.md) to complete your submission.
+   - Link any related issues in the PR description.
+
+### 4. Code Style
+To maintain code consistency:
+
+- **Follow TypeScript/JavaScript Conventions**: Write clear, readable code that follows SudoBot’s established code style.
+- **Linting and Formatting**: Run `npm run lint` (or equivalent) to ensure code passes linting rules.
+
+---
+
+## Contribution Checklist
+
+Before submitting your pull request, please ensure you:
+
+- [ ] Have thoroughly tested your changes.
+- [ ] Followed SudoBot’s code style guidelines.
+- [ ] Updated or added documentation as necessary.
+- [ ] Linked any relevant issues.
+- [ ] Confirmed that all tests pass.
+
+---
+
+## Additional Notes
+
+* Be Respectful: We value a positive and respectful community. Ensure that all interactions are constructive and supportive.
+* Ask for Help: If you're unsure about any aspect of your contribution, feel free to ask in the issue discussion or contact a maintainer.
+
+By following these guidelines, you help ensure that SudoBot remains a high-quality project. Thank you for your interest in contributing, and we look forward to your input!
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,63 @@
-<!-- A short brief about your changes here. -->
+# Pull Request for SudoBot
 
-- Is Bugfix? *Yes/No*
-- Related issues: *None*
-- Closes: *None*
+Thank you for contributing to SudoBot! Please fill out the sections below to provide context and ensure a smooth review process.
+
+---
+
+## Type of Change
+
+Please select the type of change your PR introduces:
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Enhancement
+- [ ] Documentation update
+- [ ] Refactoring
+- [ ] Other (describe below)
+
+---
+
+## Description
+
+Provide a concise description of what this pull request does. Include relevant information about the problem it solves, new features added, or improvements made.
+
+> **Description:** _Your detailed description here_
+
+---
+
+## Related Issues
+
+Does this pull request address any existing issues? If so, please list them:
+
+- Closes #ISSUE_NUMBER
+- Related to #ISSUE_NUMBER
+
+---
+
+## Checklist
+
+Please confirm that your pull request meets the following requirements:
+- [ ] I have followed the [SudoBot Contribution Guidelines](CONTRIBUTING.md).
+- [ ] I have tested my changes to ensure they work as expected.
+- [ ] My code follows the code style of this project.
+- [ ] I have added relevant documentation (if applicable).
+- [ ] I have updated tests or added new tests where necessary.
+
+---
+
+## Testing and Verification
+
+Describe any tests you've run to verify your changes. If you encountered any edge cases, please mention them here.
+
+> **Testing Steps:**
+> 1. _Describe the steps you took to test this PR._
+> 2. _List any relevant commands, inputs, or configurations._
+
+---
+
+## Additional Notes (Optional)
+
+Add any additional context, information, or screenshots here if applicable.
+
+---
+
+Thank you for your contribution! 🎉
diff --git a/docs/app/(docs)/configuration/guild-config-schema/page.mdx b/docs/app/(docs)/configuration/guild-config-schema/page.mdx
@@ -5,7 +5,7 @@ short_name: Guild Configuration
 
 # Guild Configuration
 
-SudoBot's behavior is controlled through a comprehensive JSON schema. This page provides an overview of the Guild Configuration Schema, allowing you to tailor the bot's behavior to suit your server's needs. Refer to [GuildConfigSchema.ts](https://github.com/onesoft-sudo/sudobot/blob/main/src/types/GuildConfigSchema.ts) and [SystemConfigSchema.ts](https://github.com/onesoft-sudo/sudobot/blob/main/src/types/SystemConfigSchema.ts) for the complete schema.
+SudoBot's behavior is controlled through a comprehensive JSON schema. This page provides an overview of the Guild Configuration Schema, allowing you to tailor the bot's behavior to suit your server's needs. Refer to [GuildConfigSchema.ts](https://github.com/onesoft-sudo/sudobot/blob/main/src/main/typescript/schemas/GuildConfigSchema.ts) and [SystemConfigSchema.ts](https://github.com/onesoft-sudo/sudobot/blob/main/src/main/typescript/schemas/SystemConfigSchema.ts) for the complete schema.
 
 ## Guild Configuration Schema