Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 3.21 KB

CONTRIBUTING.md

File metadata and controls

81 lines (58 loc) · 3.21 KB
Raw

Contributing to SQL Dev Tools

Thank you for considering contributing to SQL Dev Tools! We welcome contributions from everyone.

To ensure a smooth and collaborative process, please follow these guidelines:

Getting Started

  • Fork the repository to your GitHub account.
  • Clone the forked repository to your local machine: 
    git clone https://github.com/YourUsername/sql-dev-tools.git

Making Changes

  • Create a branch for your work:

    git checkout -b feature-name

    Ensure the branch name is clear and descriptive.

  • Work on your changes and commit them:

    1. Keep commits focused and concise.

    2. Use descriptive commit messages:

      git commit -m "Brief description of changes"

  • Push your changes to your forked repository:

    git push origin feature-name

Submitting Pull Requests

  • Open a Pull Request (PR) from your forked repository to the main repository's branch:

    • Provide a clear title and description for your PR, explaining the changes made.
    • Reference any related issues in the PR description.
    • Please keep updated to the owner, on your progress through images/videos in the issues comment section before raising the PR.
    • Always mention the issue number in your PR in the following format: Resolve issue: #<issue_number>
    • And also make sure to test everything before raising the PR.

  • Be responsive during the review process:

    • Address feedback or requested changes promptly.

Note:

  • For the tasks, please wait until the task is officially assigned to you before starting the work. This process helps in maintaining clarity and provides a structured approach to our tasks.
  • If you find any issue is taking too much time, please ensure to clone the recent version of the repository before making changes. This is important as others may have added new features that could affect your work.

Code Style and Best Practices

  • Maintain the existing code style.
  • Run linting and tests before submitting your changes.
  • Document any new functionality or modifications in the codebase.

Contributor's Code of Conduct

Please adhere to our Code of Conduct while contributing. Respectful and inclusive behavior is expected from everyone involved in the project.

Opening Issues

Contributions aren't limited to code! You can contribute by:

  • Reporting bugs
  • Suggesting improvements
  • Discussing broader ideas in the Issues section

Commit Guidelines

To maintain clarity and consistency in our commit messages, please follow these guidelines:

  • Use imperative mood in the subject line. For example, "Fix issue" instead of "Fixed issue" or "Fixes issue."
  • Limit the subject line to 72 characters.
  • Separate subject from body with a blank line.
  • Capitalize the subject line and each paragraph in the body.
  • Provide a detailed body explaining what changes were made and why if necessary.
  • Reference related issues or pull requests at the end of the message.

These guidelines ensure that our commit history remains clear and understandable for everyone involved in the project.

Thank You! ⭐

Your contributions, whether big or small, are valuable to us. Thank you for making SQL Dev Tools better for everyone!