-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into challenge-one
- Loading branch information
Showing
5 changed files
with
57 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
# 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: | ||
|
||
* [Fork a repo](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) | ||
* [GitHub Pull Request in 100 Seconds - Git a FREE sticker](https://www.youtube.com/watch?v=8lGpZkjnkt4) | ||
* [How to make a pull request on an open source project](https://www.youtube.com/watch?v=8A4TsoXJOs8) | ||
|
||
### Git, branches, naming, strategy... | ||
TBD |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2024 Rumen Petrov | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Pull Request checklist | ||
|
||
* [ ] I am contributing single HTML file, no folders, no any other external files even icons or images. - [Image CDN](https://placehold.co/) | ||
* [ ] My HTML is 100% valid - [HTML Validator](https://validator.w3.org/#validate_by_input) | ||
* [ ] My code is semantic (HTML/CSS/JS) | ||
* [ ] I preferred native elements than external libraries/packages | ||
* [ ] I used meaningful class names | ||
* [ ] The elements, properties or APIs I used have sufficient browser support, required by the task I worked on | ||
* [ ] My code is performant | ||
* [ ] My code follows the general best practices in web development and the style guidelines of this project |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters