Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
106 lines (74 loc) · 4.68 KB

CONTRIBUTING.md

File metadata and controls

106 lines (74 loc) · 4.68 KB

Contributing to Entity Recognition

Thank you for considering contributing to Entity Recognition! This repository serves as a library for identifying technological entities within texts and suggesting relevant technologies using advanced NLP techniques. Whether you are adding new functionality, suggesting improvements, or correcting minor errors, your contributions are highly valued.

Types of Contributions

We appreciate and accept various contributions, such as:

  • Development of new features or enhancements to leverage NLP models more effectively.
  • Updates to existing NLP patterns or configurations for better accuracy.
  • Documentation improvements to help users understand how to implement and use the features.
  • Bug fixes related to the core functionality.
  • Typo corrections in documentation or code comments.

How to Contribute

To ensure a smooth contribution process:

  • Fork the repository to your own GitHub account.
  • Clone the forked repository to your local machine.
  • Create a new branch for your contributions. Name it descriptively.
  • Make your changes, whether in code or documentation.
  • Commit your changes to your branch. Adhere to the commit message guidelines provided below.
  • Push your changes to your fork on GitHub.
  • Open a pull request (PR) against the main repository. Please include a detailed description of your contribution.

Ensure that your contributions do not break existing blueprints and are well-documented. New blueprints should be accompanied by sufficient documentation for users to implement them effectively.

Guidelines

General

Keep these guidelines in mind when contributing:

  • Code and configurations should be well-documented and maintainable.
  • Describe in the PR what the changes are, their purpose, and any issues they address or enhancements they provide.
  • Before submitting, test your changes thoroughly. Ensure they integrate smoothly without degrading existing functionalities.
  • All PRs should be reviewed by at least one other contributor or maintainer.
  • Avoid large monolithic PRs; keep them focused and modular.

Git Branch Naming

Branch prefixes help to make it clear what the purpose of the PR branch is and make it easier for reviewers to understand the changes being made. It's important to use consistent prefixes across all PR branches in the repository to maintain a clear and organized codebase.

  • feature/: Introduces new features or significant enhancements.

  • fix/: Addresses bugs or minor issues.

  • docs/: Introduces documentation improvements or additions.

  • refactor/: Modifies code or configuration changes that don't add new features.

  • test: Adds or improves tests.

  • chore/: Manages miscellaneous tasks such as dependencies updates.

  • Examples:

  • feature/spacy-enhancement: Enhances the spaCy integration for better entity recognition.

  • fix/transformer-load-issue: Fixes an issue with the loading of Transformer models.

  • docs/bertopic-usage: Expands the documentation on utilizing BERTopic for topic modeling.

Note: Commits directly on master are not accepted.

Git Commit Messages

  • Use present tense ("Add feature..." not "Added feature..").
  • Use imperative mood ("Change configuration..." not "Changes configuration...").
  • Describe what you do and not how or why you do

The following are good examples for commit messages:

Enhance spaCy matcher for JavaScript frameworks
Correct typo in Transformer configuration guide
Update installation steps for necessary NLP models

Automated Checks via GitHub Actions

Our repository uses GitHub Actions to enforce quality checks on pull requests:

  • Markdown Linting: Enforces a consistent style for our Markdown documentation using markdownlint.
  • Pre-commit Hooks: Various pre-commit hooks are in place:
    • Trailing Whitespaces and File Endings: Ensure no trailing whitespace and files end with a newline.
    • Spell Check: Utilizes codespell to catch spelling mistakes.
    • YAML/JSON Linting: Validates the syntax of YAML and JSON configurations.

These checks run automatically on every pull request. If they fail, you'll need to address the issues before your changes can be merged. Please check the output of the failed GitHub Action for details on any failures.

Getting Help

If you have any questions or need help contributing to this repository, please reach out to the maintainers by email or through:

Code of Conduct

We uphold a standard of inclusivity, respect, and cooperation. Review our Code of Conduct to ensure a positive and welcoming environment for all contributors.

Thank you for enriching Entity Recognition!