Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Хубави проекти в Github: правилата
1.Master branch-a ВИНАГИ е deployable!
В master-a винаги имате нещо стабилно, работещо, deployable. Ако почвате да правите нови неща (например сте направили конзолен TicTacToe и решавате да добавите GUI), правете си feature branch-ове и работете в тях. В момента, в който нещата са готови и стабилни, push-нете ги в Github и ги merge-нете в master.
Just github workflow, нищо специално.
2. build folder
Много хубаво си качваме целия код в github, но хората, които ще го гледат, не трябват да слагат Eclipse-и, maven–и и т.н, за да ни компилират кода, та да видят какво сме правили. Не е яко. Затова си правете една 'build' папка, в която да държите jar-овете, които са резултата от нашия код - дали application или library.
Например, ако правим игра 2048, хубаво е да имаме `build/2048.jar`
3. Хубаво README.md
README.md файлът трябва да отговаря основна на 2 въпроса:
1) Какво е това/Какъв е този проект/За какво служи?
2) Как да бъде подкаран този проект? Ако е application, как да бъде инсталиран и изпълнен, ако е библиотека - как да бъде "вързана".
Вече в 3, 4 и т.н. се слагат допълнителна информация, примери за използване, acknowledgments и т.н. Ако проекта е по-сложен (библиотека), хубаво е още преди 2) да се сложат и нейните runtime requirements.
Пример за хубав README.md файл: https://github.com/syndbg/HackBulgaria/tree/master/Core-Java-1/03-OOP1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.