Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.83 KB

contributing.md

File metadata and controls

71 lines (51 loc) · 2.83 KB

Contributing to ListSync

We're thrilled that you're interested in contributing to ListSync! This document provides guidelines for contributing to the project. By participating in this project, you agree to abide by its terms.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. How to Contribute
  4. Style Guidelines
  5. Commit Messages
  6. Pull Requests
  7. Reporting Bugs
  8. Suggesting Enhancements
  9. Questions

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: git clone https://github.com/your-username/list-sync.git
  3. Create a branch for your changes: git checkout -b your-branch-name
  4. Make your changes and commit them (see Commit Messages).
  5. Push your changes to your fork: git push origin your-branch-name
  6. Create a pull request (see Pull Requests).

How to Contribute

  • Fix bugs or implement new features.
  • Improve documentation.
  • Write tests to increase code coverage.
  • Review pull requests.

Style Guidelines

  • Follow PEP 8 style guide for Python code.
  • Use meaningful variable and function names.
  • Write clear, concise comments and docstrings.
  • Keep functions small and focused on a single task.

Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

Pull Requests

  1. Ensure your code adheres to the style guidelines.
  2. Update the README.md with details of changes, if applicable.
  3. Increase version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
  4. You may merge the Pull Request once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Reporting Bugs

  1. Use the GitHub issue tracker to report bugs.
  2. Describe the bug in detail, including steps to reproduce.
  3. Include information about your environment (OS, Python version, etc.).
  4. If possible, provide a minimal code example that demonstrates the issue.

Suggesting Enhancements

  1. Use the GitHub issue tracker to suggest enhancements.
  2. Provide a clear and detailed explanation of the feature you want to see.
  3. Explain why this enhancement would be useful to most ListSync users.

Questions

If you have any questions about contributing, please open an issue with your question. We'll do our best to provide guidance and clarification.

Thank you for contributing to ListSync! Your efforts help make this project better for everyone.