Skip to content

Latest commit

 

History

History
113 lines (85 loc) · 4.62 KB

CONTRIBUTING.md

File metadata and controls

113 lines (85 loc) · 4.62 KB
Raw

Contributing to Tailutils

Thank you for considering contributing to Tailutils! We're excited to have you on board and look forward to your contributions.

Table of Contents

Getting Started

If you're new to open source contributions, we recommend checking out First Contributions to get an overview of how to contribute to GitHub projects.

To contribute to Tailutils, follow these steps:

  1. Fork the Repository: Visit Tailutils GitHub Repo and click the "Fork" button to create your copy of the repository.
  2. Clone the Forked Repository: Clone your fork to work on it locally. 
    git clone https://github.com/YOUR_USERNAME/tailutils.git
  3. Create a Branch: Create a feature branch to isolate your work. 
    git checkout -b feature/your-feature-name
  4. Make Changes: Implement your changes or improvements.
  5. Run Tests: Ensure all existing and new tests pass.
  6. Commit Your Changes: Follow our commit message guidelines.
  7. Push Your Branch: Push to your forked repository. 
    git push origin feature/your-feature-name
  8. Submit a Pull Request (PR): Go to the Tailutils GitHub repository and open a PR from your branch.

How to Contribute

Reporting Issues

If you discover bugs or have questions, please open an issue. You can do so by following these steps:

  • Navigate to the Issues tab.
  • Click on "New Issue."
  • Provide a clear and descriptive title, and fill in the details of the problem.
  • If you can, include steps to reproduce the issue, expected behavior, and relevant information such as environment details.

Feature Requests

We welcome suggestions for new features! To propose a feature:

  • Open a new issue and label it with enhancement.
  • Describe the feature, use cases, and any relevant details on why it would improve the project.
  • Feel free to discuss your idea with us before starting development.

Pull Requests

  • Make sure there is an issue that explains the context of your PR before creating a pull request.
  • Clearly describe the purpose of your PR. Reference the issue number it addresses (e.g., Fixes #123).
  • Ensure your changes do not break existing functionality.
  • Before submitting, verify your code by running all tests and lint checks.

Development Setup

To start contributing to Tailutils, follow these steps:

Prerequisites

  • Go 1.23+: Ensure you have Go installed. Download Go.
  • Tailscale: You'll need Tailscale installed to test networking functionality. Install Tailscale.
  • Git: Git is required to clone and create branches.

Installation

  1. Clone the repository: 
    git clone https://github.com/drewwalton19216801/tailutils.git
cd tailutils
  2. Install dependencies: 
    go mod tidy
  3. Run tests: 
    go test ./...

Code Style Guidelines

  • Follow idiomatic Go conventions. For reference, see Effective Go.
  • Run go fmt before committing your code.
  • Code should be thoroughly documented, especially exported functions and types.
  • All new functionality should have associated unit tests. Aim for high code coverage.

Commit Messages

  • Write meaningful commit messages. Use the present tense and keep messages concise.
  • Example commit messages:
    • Add feature X to improve performance
    • Fix bug in message encryption flow
    • Update README with setup instructions

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the repository maintainers.

Thank you for contributing to Padserve! Together, we can create a more secure and private messaging system for everyone. We value your time, ideas, and efforts and look forward to seeing your contributions.

For any questions, feel free to ask in the discussions tab or by tagging maintainers in an issue.