Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 2.39 KB
Raw

Contributing Guide

Hello and thank you for your interest in contributing to snowflake-rs! We value all contributions and are excited to welcome you to our community. This guide will provide you with the information you need to make a contribution.

Getting Started

  1. Fork the Repository: Click the 'Fork' button at the top right of this page to create your own copy of this repository.
  2. Clone Your Fork: 
    git clone https://github.com/[YOUR_USERNAME]/snowflake-rs.git
  3. Set Upstream Remote: Navigate to the directory cd snowflake-rs and then Add the upstream remote git remote add upstream https://github.com/mycelial/snowflake-rs.git

Making a Contribution

  1. Create a new branch: From your fork, create a new branch for your feature or bug fix: git checkout -b new-feature-or-bugfix
  2. Make your changes: Edit the files and commit your changes. Please write clear and concise commit messages.
  3. Pull from upstream: Before pushing your changes, pull from upstream and integrate any changes: git pull upstream main
  4. Push your branch: Push your branch to your fork: git push origin new-feature-or-bugfix
  5. Open a pull request (PR): Go to your fork on GitHub and click the 'New pull request' button. Make sure your PR is against the main branch of the snowflake-rs repository.

PR Guidelines

  1. Small and Focused: PRs should address a single issue or add a single piece of functionality. If you're fixing multiple issues or adding multiple features, split them into separate PRs.
  2. Description: Provide a detailed description of the changes in your PR.
  3. Issue Reference: If your PR addresses an open issue, add a reference to it in the description.

Reporting a Bug

  1. Check Existing Issues: Before submitting a new issue, please check the existing issues to avoid duplicates.
  2. Be Clear and Descriptive: Use a clear and descriptive title. Describe the expected behavior and what actually happened.
  3. Provide Steps to Reproduce: List the steps that led to the bug, so others can reproduce it.

Requesting a Feature

If you have an idea for a new feature, please:

  1. Check Existing Issues: Someone else might have had the same idea!
  2. Provide a Clear Description: Explain the feature and its benefits.

Getting Help

If you have questions or need help, please reach out on Discord