Skip to content

Latest commit

 

History

History
105 lines (71 loc) · 4.47 KB

contributing.md

File metadata and controls

105 lines (71 loc) · 4.47 KB
Raw

Contributing Guidelines

Welcome to Ops Bot III (OBIII) project! We appreciate your interest in contributing. By participating in this project, you agree to abide by the following guidelines.

Table of Contents

How Can I Contribute?

There are several ways you can contribute to Ops Bot III (OBIII):

  • Reporting bugs and issues
  • Suggesting new features or enhancements
  • Writing or improving documentation
  • Fixing bugs or implementing new features through code contributions

Please read the guidelines below before making any contribution.

Getting Started

To get started with Ops Bot III (OBIII), follow these steps:

  1. Fork the project repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Install the necessary dependencies.
  4. Make your desired changes.
  5. Test your changes thoroughly.
  6. Commit your changes with a descriptive message.
  7. Push your changes to your forked repository.
  8. Submit a pull request to the original repository.

Coding Guidelines

  • Follow the established coding style and conventions of the project.
  • Write clean, readable, and maintainable code.
  • Document your code using clear and concise comments.
  • Use meaningful variable and function names.
  • Separate concerns by organizing your code into logical modules or components.
  • Write unit tests for your code when applicable.

Commit Guidelines

  • Make sure each commit has a clear and descriptive message.
  • Reference any relevant issues or pull requests in your commit message using keywords like "Fixes," "Resolves," or "Closes."
  • Keep your commits focused and avoid making unrelated changes in the same commit.
  • Squash or rebase your commits before submitting a pull request if necessary.

Issue Guidelines

  • Before submitting a new issue, search the issue tracker to check if a similar issue already exists.
  • Clearly describe the problem, including steps to reproduce it.
  • Include any relevant information or error messages.
  • Provide details about your environment, such as the operating system and version, and relevant software versions.

Pull Request Guidelines

  • Before submitting a pull request, ensure that your code follows the project's coding guidelines.
  • Clearly describe the purpose of the pull request and the changes made.
  • Reference any relevant issues or pull requests in your pull request description using keywords like "Fixes," "Resolves," or "Closes."
  • Keep your pull requests focused and avoid unrelated changes.
  • Be responsive to feedback and make necessary changes requested by the project maintainers.
  • Make sure all tests pass before submitting the pull request.

License

By contributing to Ops Bot III (OBIII), you agree that your contributions will be licensed under the project's chosen license.

Running OBIII for the First Time

To run OBIII for the first time, please refer to the README file in the repository. It provides detailed instructions on setting up the necessary configurations and dependencies.

Modular Structure

OBIII follows a modular structure and handles three types of events: slash, handlers, and scheduled. These events correspond to different ways a function can be triggered within the bot.

To contribute to the functionality of OBIII, you can create or modify the following:

Slash Commands

  • Create a new file under commands/slash/ to define a new slash command.
  • Use the provided template and follow the coding guidelines when creating the command.

Handlers

  • Create a new file under commands/handlers/ to define a new event handler.
  • Handlers execute based on specific actions and can respond to events like user joins, messages being sent, deleted, or edited, and more.

Scheduled Events

  • Create a new file under commands/scheduled/ to define a new scheduled event.
  • Scheduled events run once when the bot starts and can be used for tasks that need to be managed on their own.

Please ensure that your contributions follow the coding guidelines and provide meaningful documentation where necessary.

Conclusion

With this information, you have the necessary context to contribute to Ops Bot III (OBIII). We appreciate your contributions and encourage you to join our open-source community.

Good luck and happy coding!