Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 2.6 KB

CONTRIBUTING-EN.md

File metadata and controls

82 lines (53 loc) · 2.6 KB
Raw

Co-Labor Contribution Guidelines

한글 버전

Thank you for your interest in the Co-Labor project! 🎉


📌 Introduction

  • Please check the ISSUES to see if the problem has already been reported or if the feature has been discussed.

  • If you want to propose a new feature or report a bug, please create an issue.


Configuration

Please refer to the following documents to set up your development environment and prepare for contribution!


🛠️ How to Contirbute

  1. Create an Issue

    • Please create an issue for the part you wish to contribute to.

  2. Create a Branch

    • Please create a branch according to the issue number.
    • Branch naming convention: feat/#issueNumber or fix/#issueNumber

  3. Code Changes

    • Maintain good readability and follow package and file naming conventions.
    • Especially for variables and classes, please use Camel Case naming convention.
    • Add detailed comments.

  4. Commit

    • Please write commit messages following these conventions: 
      feat: Commit for new features
fix: Commit for bug fixes
build: Commit for build-related file changes / module installations or deletions
chore: Commit for miscellaneous changes
ci: Commit for CI-related configuration changes
docs: Commit for documentation changes
style: Commit for code style or formatting changes
refactor: Commit for code refactoring
test: Commit for test code modifications
perf: Commit for performance improvements

  5. Please follow the PR rules when creating a pull request.

    • Please follow the PR rules when creating a pull request.
    • PR title example: [feat] #69 - Add search functionality

  6. Review and Feedback

    • After creating a PR, incorporate necessary feedback through GitHub comments in consultation with the team.
    • Once feedback is reflected, commit the changes to the PR and request another review.
    • The PR will be merged after receiving final team approval.

Pull Request Checklist

[ ] Have you followed the code style guide?
[ ] Have you added tests?
[ ] Have you followed the commit convention?


License

By contributing to this project, you agree that your contributions will be licensed under the project's license.