Skip to content

Latest commit

 

History

History
84 lines (60 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

84 lines (60 loc) · 3.16 KB

Contributing to EdgeSQL Shell

Thank you for considering contributing to EdgeSQL Shell! We welcome contributions from everyone. Below are some guidelines to help you get started.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Getting Started
  4. Submitting Changes
  5. Reporting Bugs
  6. Suggesting Enhancements
  7. Code Style
  8. Attribution

Code of Conduct

This project adheres to a Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

How to Contribute

Issues

If you encounter a bug or have a feature request, please create an issue on our GitHub Issues page.

Pull Requests

We welcome pull requests for bug fixes, improvements, and new features. Here’s how to get started:

  1. Fork the repository.
  2. Create a new branch from main (e.g., feature/add-new-feature).
  3. Make your changes.
  4. Commit your changes with a clear message.
  5. Push your changes to your forked repository.
  6. Create a pull request from your fork to the main branch of the main repository.

Getting Started

To get started with the project, follow these steps:

  1. Fork the repository: Click the "Fork" button at the top right of the repository page.
  2. Clone your fork: 
    git clone https://github.com/YOUR_GITHUB_USERNAME/edgesql-shell.git
  3. Create a branch: 
    git checkout -b feature/your-feature-name
  4. Install dependencies: 
    pip install -r requirements.txt
  5. Make your changes.

Submitting Changes

  1. Test your changes: Ensure that your changes are thoroughly tested.
  2. Commit your changes: Use descriptive commit messages. 
    git add .
git commit -m "Add detailed description of your changes"
  3. Push to your fork: 
    git push origin feature/your-feature-name
  4. Create a pull request: Navigate to the main repository and click on "New Pull Request". Select the branch you created from your fork.

Reporting Bugs

If you find a bug, please create an issue on our GitHub Issues page and provide as much detail as possible, including steps to reproduce the issue, the expected outcome, and the actual outcome.

Suggesting Enhancements

We appreciate any suggestions for improving EdgeSQL Shell. To suggest an enhancement, please create an issue on our GitHub Issues page and describe your idea in detail.

Code Style

Please follow the PEP 8 guidelines for Python code. You can use tools like flake8 or black to check your code style before submitting.

Attribution

This guide was inspired by the Atom contributing guide.