Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

71 lines (49 loc) · 2.82 KB

Contributing to RPG Books

Thank you for your interest in contributing to RPG Books! We appreciate your support and efforts to make this project better. Before you get started, please take a moment to review the guidelines outlined below.

Table of Contents

How to Contribute

Contributions can come in many forms, including but not limited to:

  • Reporting bugs and issues
  • Suggesting enhancements
  • Writing code patches
  • Improving documentation
  • Providing translations
  • Sharing ideas and feedback

Please follow the guidelines mentioned below to ensure that your contribution aligns with the project's requirements and maintains a smooth collaboration process.

Getting Started

To contribute to this project, follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch based on the main branch.
  4. Make your changes and additions in the new branch.
  5. Test your changes to ensure they work as expected.
  6. Commit your changes with clear and descriptive messages.
  7. Push your changes to your forked repository.
  8. Submit a pull request (PR) from your forked repository to the original repository's main branch.

Submitting Contributions

When submitting a contribution, please make sure to provide the following details:

  • A clear and descriptive title for your contribution.
  • A detailed description of the changes you've made.
  • Any relevant information or context that can help reviewers understand the contribution better.

After submitting your contribution, the project maintainers will review it. They may provide feedback, request changes, or merge your contribution. Your patience during this process is greatly appreciated.

Code Guidelines

  • Follow the coding style and conventions used in the project.
  • Write clean, readable, and maintainable code.
  • Include appropriate comments in your code to aid understanding.
  • Ensure that your code follows best practices and is properly tested.

Issue Guidelines

If you encounter a bug or have a feature request, please submit an issue using the issue tracker. When submitting an issue, provide as much detail as possible, including:

  • A clear and descriptive title.
  • A detailed description of the issue or request.
  • Steps to reproduce the issue if applicable.
  • Any relevant logs, error messages, or screenshots.

Contact

If you have any questions, concerns, or need further assistance, feel free to reach out to the project maintainers. You can contact us via:

Thank you for your contributions and for helping to improve RPG Books!