Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: cookieauth <[email protected]>
  • Loading branch information
cookieauth authored Nov 1, 2024
1 parent 6758b39 commit 061e8b7
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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!

0 comments on commit 061e8b7

Please sign in to comment.