Skip to content

Latest commit

 

History

History
99 lines (31 loc) · 3.73 KB

CONTRIBUTING.md

File metadata and controls

99 lines (31 loc) · 3.73 KB

Contributing to 'Shout Out'

Thank you for supporting us and our project ‘Shout Out’. This is our project on Opensource Software development class, and our second project on our own. If this project fits on yours, you would need help as opensource developers. We tried to summarize our works we’ve done before, but it was not easy to make it. Reading this document will help you save time and work efficiently with the developers and other contributors.

Development Ideology

We pursue,

  1. The development which communicates each other. We think connecting each other is the most valuable development in the world. That's why we start this project.

  2. The development which shares ‘Think’ free without constraint each other. This is what we most importantly think. And you can find this pursuit is reflected on our project name, 'Shout-Out'.

  3. The development which shares values and interest fields each other. On our project, we have different categories of different fields which can share personal values and interests.

Translations

As you know, our first vital priority is 'the development which communicates'. Translating seems that it is a small work which is optional, but it is one of the most important contributions. It is a first step for everyone to communicate and share each other. If you hope to contribute as a translater, thank you for your contribution! Now we only have Korean and English. However, please be aware of reading next sentences.

Issues

This is our Issues on performing project. There are several issues we discussed. You may refer to them and contribute freely.

Pull Requests

You should read this chapter carefully not to take disadvantages and confusion, and also, to contribute well. This is our Pull Requests on performing project. You can see what we most signicantly treated and solved.

CLA

Generally, if providers want, you should sign in contributor license agreement(CLA). On our project, you do not have to sign in any contributor license agreement, but, be aware. you have to indicate copyrights when you contribute opensource software and use them. Also, if you want to contribute ours, please write your ID on CONTRIBUTOR.md. This is recommendation.

Follow the Code Style Guidelines

Before you contribute, you should better to read our Coding Convention and follow the code style guidelines. This page will help you a lot.

Submit Finished and Well-Tested Pull Requests

In terms of Pull Requests, submit finished and well-tested pull requests. Pull requests are both discussion and permission to teammates and even others. Please commit small, not a whole. you do not have to pull requests everything at once. That may decreases work efficiency of readers. Also, in same reason, polishing your pull requests and submitting is significant.

How Can I Contribute

Contribution is not a big hurdle. You may starts small. Even if you do not code directly, you may translate documents, make documents, find errors, report bugs, etc. Make sure you read this markdown and be aware of details. Thank you.

What We Are Going To Do

You may refer,

  1. Correct errors on source code.(코드 오류 수정)

  2. Code associated with community application(커뮤니티 앱에 관련된 코드 작성)

  3. Suggest additional function(추가적인 기능 제안)

  4. Design application: Logo and all UIs(앱 디자인: 앱 로고나 전체적인 UI)

  5. Test application(앱 테스터)