Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
78 lines (43 loc) · 3.9 KB

CONTRIBUTING.md

File metadata and controls

78 lines (43 loc) · 3.9 KB

Contributing to the DevRel Maturity Model

We're glad to have you here and reading this because our efforts are supported by volunteers. Thank you for taking the time to contribute your expertise to the DevRel Foundation Maturity Model project.

This document describes some contribution guidelines for the project.

Important

Before you start contributing, you must read and abide by our Code of Conduct.

You should also join the working group by subscribing here: https://lists.dev-rel.org/g/wg-resource-aggregation

You'll find it easier to make contributions if you already have a GitHub account.

Types of Contributions

Contribution can take several forms.

Discuss. Joining our working group calls and sharing your opinions and expertise is a form of contribution. It keeps our group engaging and making forward progress to hear thoughts from others.

Shoutouts. Let us know that you found resources here helpful and we'll include your show of appreciation in our testimonials.

Feedback. Have a suggestion, let us know how to improve.

References. If you know of a reference item (article, course, book, video, etc.) we will include it in the collection. This can be provided by creating an issue, sending an email to the working group owners, or best case is to fork the repos and submit a PR for review.

How-to Make a Contribution

Choose the approach that is easiest for you.

  1. (preferred) Assign an Issue to yourself or put in a PR using typical GitHub workflows for change requests.
  2. Create an Issue in the GitHub Issues for the project with the resource:personas label.
  3. Start a New Discussion in the GitHub Discussions. There is a category for feedback and one for the Persona Library more specifically. This is a great place to ask a question if unsure.
  4. Send an email to wg-resource-aggregation + owner AT lists.dev-rel.org to reach the managers who can take action on your suggestions.

What Should You Contribute

Review the Open GitHub Issues with the label resource:drmm for some ideas. If there are tags with good-first-issue this helps identify smaller projects that have fewer dependencies so somebody new to the working group can pitch in.

How-to Get Help Contributing

Use GitHub Discussions, Discord, or join one of our monthly working group calls to brainstorm and ask questions about how to contribute.

Branch Naming Convention

To help with managing large projects, there is preference for the following branch naming convention:

dev/$issue/$short-kebab-description

or

dev/$issue/$username

Review Process

Our review process is informal so we'll add guidelines here as we learn. We maintain the right to refuse accepting any content deemed inappropriate.

1. Promotional Materials

We want content that adds educational value to our community. If it is deemed promotional in nature and requires purchase of a product or service then a submission may not be accepted.

2. Paywalled Materials

We want content that is open and accessible in the index. If access to a resource requires disclosing personal information or consuming advertisements as a condition for access then it may not be accepted.

Thank You!!

We really do appreciate our contributors. We'll identify participants here who have made a significant contribution to this library.

  • Jayson DeLancey (@j12y) for contributing to the original design, schema, and resources of the Persona Library System.
  • Your name could be here next.

https://github.com/DevRel-Foundation/persona-library/graphs/contributors