Contributing

Thank you for your interest in contributing to Fairspec! As an open standard, contributions from the community help improve the specification and documentation.

Ways to Contribute

• Propose Changes: Suggest improvements to the specification
• Improve Documentation: Help clarify the documentation and add examples
• Share Feedback: Report issues or inconsistencies you find
• Join Discussions: Participate in design discussions about the standard

Using GitHub Issues

Open an issue on GitHub to:

• Report errors or ambiguities in the specification
• Suggest improvements or new features
• Ask questions about the standard
• Share use cases that aren’t well-covered

When creating an issue, please:

• Use a clear, descriptive title
• Provide context and examples when relevant
• Reference specific sections of the specification if applicable

Using GitHub Discussions

Use GitHub Discussions for:

• General questions about using Fairspec
• Sharing implementation experiences
• Discussing ideas before proposing formal changes
• Community support and best practices

Submitting Pull Requests

To propose changes to the specification or documentation:

1. Fork the repository on GitHub
2. Create a branch for your changes
3. Make your changes to the markdown files
4. Submit a pull request with a clear description

For significant changes to the specification, please open an issue or discussion first to gather feedback before investing time in a pull request.

Specification Changes

Proposals for changes to the specification should consider:

• Backward compatibility: Avoid breaking existing implementations
• Clear rationale: Explain the problem being solved
• Use cases: Provide concrete examples
• Impact: Consider effects on existing users

Getting Help

• Issues: For bug reports and feature requests
• Discussions: For questions and general discussions
• Documentation: Check the existing docs first

---

Thank you for helping improve Fairspec!