Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (61 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

84 lines (61 loc) · 2.51 KB

Contributing to Sparse Transformers

Thank you for your interest in contributing to Sparse Transformers! This document provides guidelines and instructions for contributing to this project.

Development Workflow

We follow a fork and pull request workflow for all contributions. Here's how it works:

  1. Fork the repository
  2. Create a new branch for your feature/fix
  3. Make your changes
  4. Submit a pull request

Detailed Steps

  1. Fork the Repository

    • Click the "Fork" button on the top right of the repository page
    • Clone your fork locally: 
      git clone https://github.com/YOUR-USERNAME/sparse_transformers.git
cd Sparse Transformers

  2. Create a Branch

    • Create a new branch for your changes: 
      git checkout -b feature/your-feature-name

  3. Make Changes

    • Make your changes and commit them
    • Write clear commit messages
    • Test your changes thoroughly

  4. Submit a Pull Request

    • Push your branch to your fork
    • Create a pull request against the main repository
    • Fill out the pull request template completely

Developer Certificate of Origin (DCO)

This project requires all contributors to sign off on their commits. This is done through the Developer Certificate of Origin (DCO). The DCO is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.

How to Sign Off

Each commit message must include a Signed-off-by line with your name and email address. You can add this automatically using the -s flag when committing:

git commit -s -m "Your commit message"

The sign-off line should look like this:

Signed-off-by: Your Name <your.email@example.com>

For more information about the DCO, please visit DCO App Documentation.

Pull Request Requirements

  1. Code Quality

    • Follow the existing code style
    • Write clear, maintainable code
    • Include appropriate tests
    • Update documentation as needed

  2. Commit Messages

    • Use clear, descriptive commit messages
    • Include the DCO sign-off in each commit
    • Reference any related issues

  3. Pull Request Description

    • Clearly describe the changes
    • Reference any related issues
    • Ensure all tests and checks are passing

Getting Help

If you need help or have questions:

  • Open an issue
  • Join our community discussions
  • Reach out to the maintainers

Thank you for contributing to Sparse Transformers!