Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 2.67 KB

how-to-contribute.md

File metadata and controls

39 lines (31 loc) · 2.67 KB

How to contribute to Onelinerhub

Have and idea of a useful code but don't know how to write it? Create an issue here so community might help. Search through current open issues for requested solutions you can help with.

How to contribute one or several solutions only

If you have just a quick fix (or couple) to do, you can:

  • create an issue with updated/new code to publish
  • create pull request with changes/additions you want to publish

How to apply to become constant contributor

Create new issue describing set of technologies you can help with. After approval you're going to be added to the repository as a contributor and you'll be able to push code directly.

Requirements for contributors

Basically everyone (having a github account) can contribute any amount of code solutions for any technology. You need to follow our simple guidelines:

  • code solution should be useful to other developers,
  • code should solve specific issue in a simplest possible way,
  • no need to write "ideal", "universal" or "all-possible-issues-solved" solutions, we're here to connect specific issue to it's simplest and clear solution,
  • explain your solution so it's clear for not-so-experienced or not-familiar-with engineers.

Code file (*.md) format

  • Each code file should be placed in it's main technology folder (e.g. "php", "bash", etc).
  • File should have short but understandable naming in underscore format (e.g. "redirect_header.md").
  • Extension is always ".md", so all the markdown works.
  • File must include title ("# title") as the first line.
  • File must include actual code snippet in the highlighted code block.
  • File should also include code explanation block, so it's well explained (a list with "{part} - {description}" pairs like here), markdown will work here also.
  • You can upload PNG file with the same file name as the code file and it will automatically be added to the code page in UI (like here).

Example

Given this code example, this is how it's md file looks like: Code example

This will render into:

UI example

Code templates