---

Contributing to Tether

First off, thanks for taking the time to contribute!
All types of contributions are encouraged and valued. Please read the relevant section below before making your contribution. It helps maintainers and smooths out the experience for everyone.

If you like the project but don’t have time to contribute code, you can still help by:

• ⭐ Starring the GitHub repo
• Sharing Tether on social media or with friends
• Mentioning Tether in your own project’s README
• Joining the Discord server to chat, ask questions, or give feedback

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct.
By participating, you are expected to uphold this code. Please report unacceptable behavior to maintainers.

---

Asking Questions

Before opening a question, please:

1. Read the documentation
2. Search GitHub Issues for similar questions

If you still need help:

3. Open a GitHub Issue
4. Or ask in the Discord server

Please provide as much context as possible (platform, Node.js version, etc).

---

Ways to Contribute

• Reporting bugs
• Suggesting features or enhancements
• Improving documentation
• Submitting code via pull requests
• Helping other users in Issues or Discord

---

Reporting Bugs

Before submitting a bug report:

• Make sure you’re using the latest version
• Check the documentation and existing issues
• Try to reproduce the issue with a minimal example

When opening a bug report, please include:

• Steps to reproduce
• What you expected to happen
• What actually happened (include error messages, stack traces, etc)
• Your environment (OS, Node.js version, etc)

Open a new issue here: New Bug Report

---

Suggesting Enhancements

• Search existing issues to see if your idea has already been suggested
• If not, open a New Feature Request
• Clearly describe the enhancement and why it would be useful

---

Your First Pull Request

1. Fork the repo: Eggwite/tether
2. Create a new branch: git checkout -b my-feature
3. Make your changes (see Styleguides)
4. Add/modify tests if needed
5. Commit with a clear message (see Commit Messages)
6. Push to your fork and open a Pull Request

We’ll review your PR and may suggest changes. Thank you for contributing!

---

Improving Documentation

• All docs live in the /docs/content folder
• You can edit .mdx files directly and submit a PR
• For larger changes, open an issue first to discuss

---

Styleguides

• Follow the code style used in the repo (see .editorconfig and existing files)
• Use clear, descriptive variable and function names
• Write concise, helpful comments where needed

---

Commit Messages

• Use short, descriptive commit messages (e.g. fix: handle CORS errors)
• Reference issues or PRs when relevant (e.g. closes #42)

---

Join the Project Team

If you’re interested in becoming a maintainer or regular contributor, reach out on Discord or open an issue!