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

Standardized best practice template directions #118

Merged
merged 2 commits into from
Oct 23, 2023
Merged

Standardized best practice template directions #118

merged 2 commits into from
Oct 23, 2023

Conversation

riverma
Copy link
Collaborator

@riverma riverma commented Oct 17, 2023

Include new standard template directions.

Purpose

  • A new standard template for best practice guides to ensure consistency and ease of readability

Proposed Changes

  • [ADD] New template section within existing contribution guide

Issues

Testing

Include new standard template directions.
@riverma riverma changed the title Update submit-best-practice.md Standardized best practice template directions Oct 17, 2023
@riverma riverma requested a review from a team October 17, 2023 23:42
@riverma riverma self-assigned this Oct 17, 2023
@riverma riverma added requested Requested by community members at a low level low complexity Ticket is relatively easy & straightforward to resolve information sharing Process improvements involving documentation, training, guides, communication, etc website Improvement / fix to the SLIM website labels Oct 17, 2023
Copy link
Contributor

@jpl-jengelke jpl-jengelke left a comment

Choose a reason for hiding this comment

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

I would try to reduce the number of steps in the Find or Make a Ticket and the Make a Pull Request sections.

In the Find or Make a Ticket section, I think 2/3/4 and 6/8 can be combined. Similarly, for Make a Pull Request I think 2/4/5 and 6/7 can be combined.

This comment is based on the sheer number of steps, pre-existing familiarity with those steps and my intuition that long lists will deter interaction.

@riverma
Copy link
Collaborator Author

riverma commented Oct 18, 2023

I would try to reduce the number of steps in the Find or Make a Ticket and the Make a Pull Request sections.

In the Find or Make a Ticket section, I think 2/3/4 and 6/8 can be combined. Similarly, for Make a Pull Request I think 2/4/5 and 6/7 can be combined.

This comment is based on the sheer number of steps, pre-existing familiarity with those steps and my intuition that long lists will deter interaction.

Thanks @jpl-jengelke - agreed! The steps are a bit lengthy. Let me see what can be done.

Reorganizing guide and simplified wording.
@riverma riverma merged commit 00fcd3a into main Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
information sharing Process improvements involving documentation, training, guides, communication, etc low complexity Ticket is relatively easy & straightforward to resolve requested Requested by community members at a low level website Improvement / fix to the SLIM website
Projects
Status: ✅ Work Complete
Development

Successfully merging this pull request may close these issues.

2 participants