Skip to content

Latest commit

History

History
36 lines (21 loc) 路 2.39 KB

CONTRIBUTING.md

File metadata and controls

36 lines (21 loc) 路 2.39 KB

Contribution Guidelines

Adding your favorite material to this library is easy and very welcome.

Which things am I allowed to add?

Since we want to maintain a high level of quality and limit the length of lists, please only submit entries that you personally read and found very useful.

This project only lists content that is publicly available and easily digestible (read, audio, video). We don't have a section for books as of yet.

Authors: Please don't submit your own work. This makes it harder to rate the validity of the suggestion for us. If it's a valuable work, you can always encourage another DevRel to submit it for you.

Adding an article, video or podcast

If you have something awesome to contribute, this is how you do it.

You'll need a GitHub account!

  1. Access the GitHub page: https://github.com/buildwithusers/awesome-devrel-library#readme
  2. Click on the topic you'd like to contribute to
  3. Now click on the edit icon. Step 3 - Click on Edit
  4. You can start editing the text of the file in the in-browser editor. Make sure you follow guidelines above. You can use GitHub Flavored Markdown. Please follow the formatting of other links and include your main takeaway in max 3 lines. We try to roughly order the items by quality level, although this is very subjective.
  5. Say why you're proposing the changes, and then click on "Propose file change". Step 5 - Propose Changes
  6. Submit the pull request!

Updating your Pull Request

Sometimes, a maintainer will ask you to edit your Pull Request before it is included. This is normally due to spelling errors or because your PR didn't match the guidelines.

Here is a write up on how to change a Pull Request, and the different ways you can do that.

Suggestions for project structure/improvement

If you have suggestions on how we can improve the project or add different types of resources, please open a GitHub issue with a clear description. You can also create a Pull Request and link it to the issue.