Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

33 lines (26 loc) · 2.83 KB
Raw

Thank you for your interest in contributing to the M31DB project! We appreciate your efforts to help improve and enhance our database management system. To ensure a collaborative and efficient experience for all contributors, we have established the following guidelines:

  1. Familiarize Yourself with M31DB:

    • Take the time to understand M31DB's purpose, architecture, and functionality. Read the documentation available in the repository to gain a good understanding of the system.
    • Review the existing issues and pull requests to avoid duplicating efforts or proposing changes that have already been addressed.

  2. Create an Issue:

    • Before starting any significant contribution, create an issue to discuss the proposed change or enhancement. Clearly describe the problem you intend to solve or the feature you plan to add. This allows for valuable feedback and helps coordinate efforts.

  3. Fork the Repository:

    • Fork the M31DB repository to your GitHub account.
    • Create a new branch for your contribution. Use a descriptive branch name that summarizes the purpose of your changes.

  4. Code Development:

    • Adhere to the project's coding style and guidelines. Maintain consistency with the existing codebase.
    • Write clear and concise commit messages, summarizing the changes made in each commit.
    • Break your changes into logical and manageable commits. Each commit should focus on a specific aspect of the overall contribution.
    • Include tests for your code changes. Ensure that existing tests pass and add new tests where applicable to maintain or improve code quality.

  5. Submitting Pull Requests:

    • Once you have completed your changes, submit a pull request from your branch to the main repository's master branch.
    • Provide a clear and descriptive title for your pull request.
    • Include a detailed description of the changes made, the problem addressed, or the new feature added.
    • Reference the relevant issue(s) in your pull request description, if applicable.
    • Be prepared to address any feedback or suggestions during the review process.

  6. Collaboration and Communication:

    • Be respectful and professional when interacting with other contributors, maintainers, and users of the project.
    • Participate in discussions, provide constructive feedback, and help review other pull requests when possible.
    • Respond to feedback and comments on your contributions promptly and thoughtfully.
    • Keep communication channels open and transparent, ensuring that discussions take place in the appropriate forums, such as issue comments or pull request discussions.

By following these contributing guidelines, you will effectively contribute to the development and improvement of M31DB. Your contributions are highly valued, and we appreciate your dedication to enhancing our database management system for the benefit of the community.