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 instructions for adding a post #3821

Open
1 task
beechnut opened this issue Apr 12, 2024 · 3 comments
Open
1 task

Missing instructions for adding a post #3821

beechnut opened this issue Apr 12, 2024 · 3 comments
Labels

Comments

@beechnut
Copy link
Contributor

beechnut commented Apr 12, 2024

There's no "Contributing" section in this README, which is the first place people look for guidance on contributing. There's a CONTRIBUTING.md file, but there's enough files in the project root that it's easy to overlook.

Definition of done

  • a "Contributing" section in the README that references any other instructions
@juliaklindpaintner
Copy link
Member

Noting that we will likely revise this ticket. We acknowledge that the instructions for adding a blog post should be documented, but don't necessarily think it should be added to a Contributing section in the README since we're not asking the general public viewing the repo to contribute to the blog.

@edwintorres
Copy link
Member

Can we clarify the ask here a little bit more? @beechnut is about blog posts or contributing to the 18F site.

@beechnut
Copy link
Contributor Author

I'd say the user story is something like: As a new member of 18F who wants to contribute a blog post or an update to the site, I want to figure out relatively quickly how to start contributing.

The current language in the README is a lot of context, but nothing that points the person: here's where to go to start a blog posts, here's where to go to update the site.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants