Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 1.58 KB
Raw

Contribution guide

How to participate in a challenge?

  1. Your contribution should fit on single HTML file, no folders, no any other external files even icons or images. You could use inline SVGs or CDN, if it is really necessary.
  2. Navigate to the folder which represents the challenge you want to participate in (/public/challenge-contributions/THE_NUMBER_OF_THE_CHALLENGE).
  3. Find the HTML file with your name and write the code you want to contribute. It is named using the first letter of your first name in combination with your last name.
  4. You could use any of the methods described below to access the project.

How to add my code to the project?

Option 1: Request access to the project

You could requires access writes to the project then you could use the GitHub UI to upload a HTML file. Alternatively you clone the project locally, create branch and submit your files by opening a PR to master.

Option 2: Fork it

You could fork the project and then open PR to the upstream project. Here are couple links you might find useful:

Git, branches, naming, strategy...

The branches created for contributing to a challenge should follow this naming convention

challenge-$CHALLENGE_NUMBRE/$CONTRIBUTOR_NAME
# Example
challenge-1/asavov