Skip to content

📝 Add contribution guidelines to the repository - #122

Open
lavigarg-simform wants to merge 1 commit into
masterfrom
docs/contribution-guide
Open

📝 Add contribution guidelines to the repository#122
lavigarg-simform wants to merge 1 commit into
masterfrom
docs/contribution-guide

Conversation

@lavigarg-simform

Copy link
Copy Markdown
Contributor

Description

Added a detailed contribution guide for the package.

Checklist

  • The title of my PR starts with a Conventional Commit prefix (fix:, feat:, docs: etc).
  • I have followed the Contributor Guide when preparing my PR.
  • I have updated/added tests for ALL new/updated/fixed functionality.
  • I have updated/added relevant documentation in doc/ and/or package README(s), and added dartdoc comments with /// where applicable.
  • I have updated/added relevant examples in example/ and/or splash_master_{rive,video,lottie}/example/.
  • I have updated impacted package metadata/docs (for example: README.md, CHANGELOG.md, and package-level docs where applicable).

Impacted package(s)

  • splash_master (core)
  • splash_master_rive
  • splash_master_video
  • splash_master_lottie

Breaking Change?

  • Yes, this PR is a breaking change.
  • No, this PR is not a breaking change.

Related Issues

None

@lavigarg-simform

lavigarg-simform commented May 18, 2026

Copy link
Copy Markdown
Contributor Author

Note- GitHub Discussions has not been enabled for this package yet
@vatsaltanna-simformsolutions @apurva-simform

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new CONTRIBUTING.md document to define how external contributors should report issues and submit pull requests for Splash Master.

Changes:

  • Introduces contribution guidance covering bug reports, bug fixes, new features, and documentation changes.
  • Adds contributor workflow steps (fork/branch/commit/PR) and a maintainer section for merging and releases.
Comments suppressed due to low confidence (1)

CONTRIBUTING.md:39

  • Use the correct "GitHub" capitalization in link text (currently "Github").
- As always first file a [Github issue].

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
@lavigarg-simform
lavigarg-simform force-pushed the docs/contribution-guide branch from bc63745 to 7948eb4 Compare May 18, 2026 13:27
@lavigarg-simform
lavigarg-simform marked this pull request as ready for review May 18, 2026 13:27
@lavigarg-simform
lavigarg-simform force-pushed the docs/contribution-guide branch from 7948eb4 to 1bb6505 Compare May 18, 2026 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants