Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
112 lines (84 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

112 lines (84 loc) · 2.48 KB

Contributing

Thank you for your interest in contributing!

Ways to Contribute

1. Report Bugs

Found a bug? Help us fix it!

2. Suggest Features

Have an idea for improvement?

3. Improve Documentation

  • Fix typos
  • Clarify explanations
  • Add examples
  • Translate to other languages

4. Submit Code

  • Fork the repository
  • Create a feature branch
  • Make your changes
  • Submit a pull request

Development Setup

# 1. Fork and clone
git clone https://github.com/YOUR_USERNAME/Units_of_Measure_Harmonization-intelligence-platform.git
cd Units_of_Measure_Harmonization-intelligence-platform

# 2. Create a branch
git checkout -b feature/your-feature-name

# 3. Make changes
# (edit files in KNIME or code)

# 4. Test thoroughly
# Run the workflow with test data

# 5. Commit with descriptive message
git commit -m "feat: add support for new unit types"

# 6. Push and create PR
git push origin feature/your-feature-name

Pull Request Guidelines

Before Submitting

  • Code follows project style
  • Tests pass
  • Documentation updated
  • No merge conflicts

PR Title Format

Use conventional commits:

  • feat:: New feature
  • fix:: Bug fix
  • docs:: Documentation
  • style:: Formatting
  • refactor:: Code restructuring
  • test:: Adding tests
  • chore:: Maintenance

PR Description

Include:

  • What changed
  • Why it changed
  • How to test it
  • Screenshots (if UI changes)

Code Style

KNIME Workflows

  • Use descriptive node names
  • Add comments for complex logic
  • Group related nodes
  • Keep workflows clean and organized

Documentation

  • Use clear, simple language
  • Include code examples
  • Add images where helpful
  • Keep line length under 100 characters

Getting Help

Recognition

Contributors are added to:

  • README contributors section
  • CHANGELOG
  • GitHub contributors page

License

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you for making this project better!