Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 2.97 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 2.97 KB

Contributing Guidelines for verse.db

Welcome! We appreciate your interest in contributing to verse.db. This document outlines the guidelines for submitting code, reporting issues, and participating in the project.

Getting Started

  1. Fork the Repository:
    Before making changes, create a fork of the verse.db repository on [place holder for version control system, e.g. GitHub, GitLab]. This allows you to develop and test your changes in your own space before submitting them to the main project.

  2. Set Up a Development Environment:
    Follow the instructions in the README file to set up your development environment. This will ensure you have the necessary tools and dependencies to work on verse.db.

Making Changes

  1. Focus on a Specific Issue:
    If you're looking to contribute code, check the existing issues list for something you'd like to address. This helps keep the development focused and avoids duplicate efforts.

  2. Create a Branch:
    Create a new branch for your specific changes. This helps isolate your work from the main codebase. Use a descriptive branch name that reflects the issue you're addressing (e.g., fix-data-type-handling).

  3. Write Clean and Documented Code:
    Follow the existing code style and formatting guidelines. Add clear comments to explain your changes, especially for non-trivial modifications.

  4. Write Unit Tests:
    Whenever possible, write unit tests that cover the functionality you've added or modified. This helps ensure the correctness and maintainability of the code.

  5. Submit a Pull Request:
    Once your changes are complete and tested, push your branch to your fork and submit a pull request to the main verse.db repository. Include a clear and concise description of your changes and how they address the issue (if applicable).

Reporting Issues

  1. Search for Existing Issues:
    Before submitting a new issue, check the existing issue list to see if someone has already reported the problem.

  2. Provide Clear Descriptions:
    When reporting a new issue, provide a clear and detailed description of the problem you're encountering. Include steps to reproduce the issue, expected behavior, and any relevant error messages.

  3. Use Descriptive Titles:
    Use a descriptive title for your issue that accurately reflects the problem.

Additional Guidelines

  • Respectful Communication:
    Maintain a respectful and professional tone in all interactions with other contributors.

  • Code Style:
    Follow the existing code style and formatting guidelines for verse.db.

  • Continuous Integration (Optional):
    If you're familiar with continuous integration (CI) tools, consider setting up a CI pipeline for your pull request. This helps automatically test your code before it's merged into the main codebase.

Thank You!

We appreciate your contributions to verse.db! By following these guidelines, you can help us create a better and more robust local database package.