Skip to content

Commit

Permalink
feat: add contributing and license
Browse files Browse the repository at this point in the history
  • Loading branch information
iniakunhuda committed Oct 22, 2024
1 parent 569582e commit df74f10
Show file tree
Hide file tree
Showing 4 changed files with 109 additions and 2 deletions.
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Contributing Guide

Thank you for your interest in contributing to this repository for Hacktoberfest 2024! We appreciate all contributions, whether you're fixing bugs, adding features, or improving documentation. Please follow the guidelines below to ensure a smooth contribution process.

## Setup Guide / Getting Started

To get started with contributing:

1. **Pick an Issue**: Browse through the [issues section](https://github.com/surabayadev/tutorial-css-lengkap/issues) and pick an issue you'd like to work on.
2. Comment on the Issue: Let us know you're working on the issue by commenting on it. This helps avoid duplicate work and lets us know the issue is being addressed.
3. Admin will assign the issue to you.
4. **Fork the Repository**: Click on the fork button to create a copy of this repository in your GitHub account.
5. **Clone Your Fork**: Clone your forked repository to your local machine:
```bash
git clone https://github.com/your-username/your-repository.git
```
6. Install Dependencies: Install any necessary dependencies by running the following command:
```bash
pnpm install
```
7. Create a Branch: When you're ready to start working, create a new branch based on main.
## Branch Naming
When creating a new branch for your work, follow this naming convention:
```bash
git checkout -b feat/materi1-chapter1
```
Where `feat/materi1-chapter1` indicates the feature you're working on. Replace with the specific task or issue you're addressing.
## Commit Style
All commits must follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. This ensures a consistent commit history and makes it easier to track changes. The format is:
```bash
<type>(optional scope): <description>
```
Some common commit types:
- `feat`: A new feature
- `fix`: A bug fix
- `docs`: Documentation changes
- `style`: Code style changes (formatting, no code changes)
- `refactor`: Refactoring code (neither fixes a bug nor adds a feature)
## Submitting Pull Requests
1. Once you have completed your changes, push your branch to your forked repository:
```bash
git push origin your-branch-name
```
2. **Create a Pull Request**: Navigate to the original repository and create a pull request from your branch. Make sure to:
- Provide a clear description of the changes.
- Tag `@iniakunhuda` in the pull request for review.
3. **Review Process**: Your pull request will be reviewed by `@iniakunhuda`. Once approved (LGTM), it will be merged into the main branch.
Happy coding, and thank you for contributing!
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 SurabayaDev

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.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,30 @@
# TutorialKit Starter
# Tutorial CSS Lengkap

👋 Welcome to TutorialKit!
SurabayaDev membuat kelas tutorial lengkap CSS untuk pemula hingga mahir dalam bahasa Indonesia. Tutorial ini akan membahas dasar-dasar CSS, layout dan positioning, responsivitas, animasi, hingga tips dan trik lanjutan dalam pengembangan web.

![image.png](image.png)

## Daftar Materi

Daftar materi CSS selengkapnya dapat dilihat di [daftar materi](https://github.com/surabayadev/tutorial-css-lengkap/issues/1).

Apabila ada materi yang ingin ditambahkan, silakan untuk membuat komentar di issue tersebut.

## Kontribusi

Kami mengundang siapa saja untuk berkontribusi dalam pengembangan tutorial ini. Silakan ikuti panduan kontribusi di [CONTRIBUTING.md](CONTRIBUTING.md).

Repository ini juga terbuka untuk event Hacktoberfest 2024.

## Lisensi

Tutorial ini dilisensikan di bawah [Lisensi MIT](LICENSE).

<br><br>

# TutorialKit

We are using TutorialKit to create this tutorial.

This README includes everything you need to start writing your tutorial content quickly.

Expand Down
Binary file added image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit df74f10

@iniakunhuda
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#3 Done, updated

Please sign in to comment.