Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

50 lines (36 loc) · 2.85 KB
Raw

Contribution Guidelines for Khmer Natural Language Processing

Welcome to the Khmer Natural Language Processing (NLP) project! We appreciate your interest in contributing to our project. Before making any contributions, please read the following guidelines to ensure a smooth and effective collaboration process:

✨ Code of Conduct

We are committed to fostering an open and inclusive community. Please review and adhere to our Code of Conduct at all times.

🚀 Getting Started

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine. 
      git clone https://github.com/Khmer-NLP/khmer-nlp.git

📖 Create a new branch for your work

Be clarify what you are doing with your skill to make an effective task completion.

Example: Optimizing models and collect dataset, your branch should be named feature/model-optimization

git checkout -b feature/model-optimization

💡 Contribution Guidelines

If you encounter a bug, please check the Issues section to see if it has already been reported. If not, feel free to open a new issue providing detailed information about the bug. For feature requests, open a new issue outlining the proposed feature and its potential benefits.

💗 Pull Requests

Before submitting a pull request, ensure that your code adheres to the project's coding standards and formatting guidelines. Clearly describe the purpose of your pull request and provide a summary of the changes. If your pull request addresses an existing issue, reference the issue number in the pull request description. All new features or changes should include appropriate tests to ensure proper functionality

💻 Code Review

Pull requests will undergo code review by project maintainers. Be open to feedback and be prepared to make any necessary changes to your code. Code reviews are conducted to maintain code quality, consistency, and compatibility with project goals.

📂 Documentation

Improvements to project documentation are always welcome. If you notice any inaccuracies or areas for improvement, please submit a pull request with your proposed changes.

📫 Commit Messages

Write clear and descriptive commit messages that explain the purpose of each commit concisely. Use present-tense verbs and provide detailed explanations of the changes made.

🤝 Community Support 🇰🇭

If you have any questions or need assistance, don't hesitate to reach out to the community via our communication channels. We're here to help and support each other. Thank you for your contributions to the Khmer NLP project! Together, we can make a meaningful impact on NLP advancements for the Khmer language.

You can save this content in a file with a .md extension, such as CONTRIBUTING.md.