Skip to content

docs: clarify submissions workflow#575

Open
saurabhhhcodes wants to merge 1 commit into
SAPTARSHI-coder:mainfrom
saurabhhhcodes:docs/submission-workflow-347
Open

docs: clarify submissions workflow#575
saurabhhhcodes wants to merge 1 commit into
SAPTARSHI-coder:mainfrom
saurabhhhcodes:docs/submission-workflow-347

Conversation

@saurabhhhcodes
Copy link
Copy Markdown
Contributor

Pull Request Description

Improves the submissions workflow guide so new contributors can understand the expected folder structure, review standards, rejection reasons, and a compact example before opening a PR.

Fixes #347


Type of Change

  • New animation / hover effect
  • New component
  • Documentation improvement
  • Bug fix in an existing submission
  • Other (describe below)

Submission Checklist

  • All changes are inside submissions/examples/your-feature-name/
  • Includes demo.html - self-contained, opens in browser with no server
  • Includes style.css - raw CSS for the proposed feature
  • Includes README.md - what it does, how to use it, why it fits EaseMotion CSS
  • No changes to core/
  • No changes to components/
  • One feature per PR (no bundled unrelated changes)

Note: this issue explicitly asks for documentation changes in submissions/README.md, so the demo/style/submission-folder checklist items are not applicable to this PR.


Feature Description

What does this add?

A clearer contributor workflow for building submission folders, understanding what reviewers look for, and avoiding common rejection reasons.

How does a developer use it?

Developers read submissions/README.md before creating a new folder under submissions/examples/.

Why does it fit EaseMotion CSS?

It keeps the curated submission model easier to follow and reduces review churn for new contributors.


Demo

  • Demo added (demo.html works by opening directly in a browser)

Not applicable: documentation-only workflow guide update.


Browser Testing

  • Chrome
  • Firefox
  • Edge
  • Safari (optional but appreciated)

Not applicable: documentation-only Markdown update.


Validation

  • submission README checks passed
  • git diff --check -- submissions/README.md

Note: the local clone has a pre-existing case-collision dirty file at submissions/examples/parallax-tilt-effect/README.md; it was not staged or committed.


Notes for Maintainer

I kept this limited to submissions/README.md because #347 specifically asks for the submissions workflow docs. No core/components files were touched.

@saurabhhhcodes
Copy link
Copy Markdown
Contributor Author

Validation proof for review:

  • submission README checks passed: new workflow, good/rejected criteria, and example sections are present; Markdown fences are balanced.
  • git diff --check -- submissions/README.md passed.
  • No core/ or components/ files were changed.

Note: this is documentation-only for issue #347, which explicitly asks for submissions/README.md workflow docs. The local clone has a pre-existing case-collision dirty file under submissions/examples/parallax-tilt-effect that was not staged or committed.

If this is accepted for GSSoC, please add the scoring labels such as gssoc:approved, level:intermediate, type:feature or documentation.

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.

Create docs for submissions/README.md workflow

1 participant