New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

위키페이지들을 소스저장소 내 markdown파일로 관리하면 어떨까요? #7

Open

jwChung opened this issue Sep 1, 2014 · 1 comment

Member

jwChung commented Sep 1, 2014

위키페이지들은 누구나 글을 수정하고 작성할 수 있는 장점이 있지만, 작성된 글은 개제되기 전에 오직 작성자에 의해서만 검토되어지고 작성자의 실수는 고스란히 수정없이 개제되어 버리는 단점이 있습니다.

따라서, 위키페이지를 readme.md 파일과 같이 소스저장소 내 markdown파일로 관리하면 어떨까 합니다. 이렇게 된다면 github에서 제공하는 pull request(이하 PR) 이라는 막강한 기능을 이용하여 위 단점을 극복할 수 있다는 생각이 듭니다.

또한, PR을 통한다면 위키페이지의 내용과 형식적인 면에서 조금 더 일관성을 부여할 수 있다고 생각됩니다. PR을 merge할 수 있는 권한을 가진 사람들끼리 위키페이지의 형식 및 내용에 관한 규칙을 만들어 PR들이 이 규칙을 만족하도록 유도할 수 있습니다.

아울러, 소스저장소 내 markdown로 관리 된다면 위키페이지와 같이 누구나 직접 웹상에서 수정 또는 글 작성을 할 수 있습니다. 다만 이 때는 위키페이지처럼 바로 반영되는 것이 아니라 자동으로 PR를 보내게 됩니다.

Member Author

jwChung commented Sep 1, 2014

PR에 대한 좋은 내용의 글이 있어서 링크 남깁니다.

jwChung changed the title ~~위키페이지들을 소스 저장소 내 markdown파일로 관리하면 어떨까요?~~ 위키페이지들을 소스저장소 내 markdown파일로 관리하면 어떨까요?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment