title | cover |
---|---|
Contribution Guide |
/img/colaboration.jpg |
Kumlaude adalah project open source untuk mahasiswa ilmu komputer ugm, berisi materi-materi belajar yang bersangkutan dengan ilmu komputer. Website dari repo ini adalah https://fajarnuha.github.io/kumlaude
Semua konten-konten disini adalah hasil kolaborasi penulisan mahasiswa-mahasiswa ilmu komputer. Semua orang bisa mengajukan usulan penulisan dengan pull-request(PR), dan akan di review oleh maintainer repository ini, jika kiranya bermanfaat, usulan akan diterima dan di publish ke website Kumlaude
Konten bisa berisi tulisan, gambar, links, video, tips-trick, review dosen, info ujian, code, atau apapun asal bermanfaat
Konten tidak harus yang panjang dan ribet. Hanya 1-2 baris boleh asalkan bermanfaat. Tidak usah takut salah, project ini open source, jadi kalau salah ntar akan ada orang yang benerin
Kamu boleh nambah tulisan di artikel yang sudah ada, atau bisa juga buat konten/folder/topic jika belum ada. Tinggal PR aja!
Semua orang, tapi ada 4 kategori orang di project ini:
- User : semua mahasiswa ilmu komputer yang ingin belajar biar cumlaude
- Content Contributor : semua mahasiswa yang menulis hal yg bermanfaat disini
- Code Contributor : mahasiswa yang membuat website ini berjalan dan beraparas lebih keren
- Maintainers : mahasiswa yang mengevaluasi PR dan maintain website
Konten-konten di kumlaude, termasuk guide ini, berupa file-file markdown yang notabene mirip txt biasa tp lebih canggih.
Jadi belajar trik-trik markdown dulu biar kontennya makin apik. Markdown Cheatsheet
Sebelumnya, kalau kamu ini di website, pergi dulu ke Github nya
Ada 2 cara kontribusi:
Gampang
- Pergi ke
content/colab
di repo kumlaude, cari artikel yang ingin ditulis atau diedit. Biasanya nama filenya index.md di tiap topic folder - Click icon pensil "Edit this file" dan buat changes dalam file di Github-flavored Markdown
- Scroll kebawah dan tambahkan commit message yang menerangkan changes kamu. Kemudian pilih "Create a new branch for this commit and start a pull-request", kemudian pilih "Propose file changes"
- Kemudian, kamu bisa tambahkan detail lainnya, lalu "Create pull request"
Developer Way
- Fork repo
- clone repo ke local dengan command
git clone https://github.com/YOUR-GITHUB-USERNAME/kumlaude.git
- Tambah remote upstream
git remote add upstream https://github.com/fajarnuha/kumlaude.git
- Buat branch baru untuk kerjaanmu dengan
git checkout -b NEW-BRANCH-NAME
. Kasih nama yang logis - Commit changes di lokal dulu dengan
git commit -m "SHORT MESSAGE"
. Push ke remotegit push origin NEW-BRANCH-NAME
- Ke repo kamu di Github terus open PR
- Lihat issues di Github jika ingin contribute code
more on Pull Request
Pahala insyaaAllah, karena ini termasuk amalan ilmu yang bermanfaat (setiap kali dibaca orang lain). Uang ga ada. However, maintainers dan top contributor akan ada di halaman About. Jadi berlomba-lombalah!
masih on progress, jadi belum ada aturan aneh-aneh, yang penting website ini terisi dulu
Supaya pull request kamu diterima, coba perhatikan hal berikut:
- Wajib kasih
title
di markdown - Nama file adalah
index.md
kecuali di topic notes, which is sesuai notes yg ditulis, egbinary-search.md
- Taruh gambar cover dengan kasih
cover
di frontmatter (optional, jika kosong gambar akan random)
contoh index.md
di folder kalkulus-1 dengan cover
---
title: "Calculus 1"
cover: "http://dennydio.staf.akprind.ac.id/wp/wp-content/uploads/2017/09/images.png"
---
- Mewakili kategori yang bersangkutan.
- Nama folder harus mengikuti skema
kebab-case
You are more than welcome to make this site better/prettier
In this repo, we learn:
- Gatsby JS
- JS Components
- GraphQL
- Markdown
- SCSS
- Git
- Travis CI