Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing Showcase submission instructions #122

Open
juni-b-queer opened this issue Apr 18, 2024 · 2 comments
Open

Missing Showcase submission instructions #122

juni-b-queer opened this issue Apr 18, 2024 · 2 comments

Comments

@juni-b-queer
Copy link
Contributor

When I went to the showcase page and clicked the "Submit your project here" there were no instructions or best practices to follow. I went through previous PRs that added items to the showcase and figured it so I just submitted my first showcase project #121!

I'm not saying it needs a detailed walk through, but any mention of submissions in the Readme would be nice if that's where the submission link directs to.
Questions that would be helpful to know

  • Where are the submissions located? (src/data/users.tsx)
  • Where should I put my submission? Is there any order, or just at the end? (I just assumed the end)
  • Where should I put the image?
  • What are the image requirements/limitations?
  • What are the qualifiers for each of the tags?
  • What needs to be included in the submission object?
  • What should the PR look like?

This added documentation could be as simple as

Submitting to the Community Showcase

  1. Fork the bsky-docs repo
  2. In src/data/users.tsx, add your submission with {include required info}
  3. (Optional) Add photo to src/data/showcase/ {include image requirements/limitations}
  4. Commit changes to a branch in your fork
  5. Make a PR to merge your branch into the main bsky-docs {include what's needed in the PR}
  6. Done! (?)

I'm also more than happy to make a PR to add this, but I don't have the answers to all of the questions right now.

@Sanhajio
Copy link
Contributor

Fork the project and submit a PR, I had the same question, I git diff <commit_hash> to know how projects are added, but having a process would have helped

@lamrongol
Copy link

lamrongol commented Jul 3, 2024

I agree with this, I especially want to know the details.
Edited: I noticed User elements and tags list exist on users.tsx

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

No branches or pull requests

3 participants