How to Contribute

How You Can Help Build Shutterpaws

Whether you’re technical or not, you can contribute to Shutterpaws. This guide covers common ways to help, including content updates and code contributions.

Quick Ways to Help

• Upload event cover photos
• Fix typos and copy updates
• Suggest new events
• Update your team profile
• Improve docs and developer workflows

Issue Templates (Please Use These)

When you open an issue, choose one of the templates:

• Feature request
• Bug report
• Spike / investigation

For feature, bug, and spike issues, include:

• Problem statement
• Scope (what is in/out)
• Acceptance criteria
• Related issues (including parent/sub-issues)

Labeling and issue breakdown guidance:

• Maintainers: apply relevant labels (bug, enhancement, documentation, technical).
• Create sub-issues when implementation can be split into independent work streams.

Non-Technical Contributions

Events

Events (creation, cover photos, editing) are now managed through the plans-bot admin UI, not this repository. Contact an admin for access.

Fixing Typos

1. Locate the source file in the repository.
2. Edit the file in GitHub.
3. Propose your change and open a pull request.

Updating Your Team Profile

Team member profiles live under src/content/our-team/[name]/index.md.

You can update your:

• Display name and role
• Bio text
• Social links
• Fursona links
• Profile photo

Git & Code Contributions

For local development:

1. Fork and clone the repository.
2. Create a feature branch.
3. Make your changes.
4. Run validation and tests locally.
5. Open a pull request.

For setup details, see the README.md file in the repository root.

Pull Request Checklist

• Clear, descriptive PR title
• Explanation of what changed and why
• Paths and naming conventions followed
• Spelling/formatting checked
• Validation/tests run when applicable

Getting Help

• Open a GitHub issue or discussion
• Ask in Telegram
• Comment directly on your pull request if you get stuck

Legal & Licensing

By contributing content, you confirm you own the content (or have permission to share it) and grant Shutterpaws permission to publish it according to project policies.