Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
69 lines (53 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

69 lines (53 loc) · 3.49 KB
Raw

Contributing to kgforge

Welcome

Hello! I'm glad and grateful that you're interested in contributing to kgforge 🎉! Below you will find the general guidelines for setting up your environment and creating/submitting pull requests.

Table of contents

Environment Setup

Steps:

  1. Create a new env. kgforge currently supports python 3.11
  2. Fork kgforge
  3. Install all required and development packages in your new env (I use poetry for dependency management).
poetry install --all-extras --with dev,dev-lints

Contributing Changes

  1. Create a new branch for your addition
    • General naming conventions (we're not picky):
      • /username/<featureName>: for features
      • /username/<fixName>: for general refactoring or bug fixes
  2. Test your changes:
    • You can run formatting, lints and tests locally via poetry run python3 -m unittest discover, respectively.
  3. Submit a Draft Pull Request. Do it early and mark it WIP so I know it's not ready for review just yet. You can also add a label to it if you feel like it 😄.
  4. Move the pull_request out of draft state.
    • Make sure you fill out the pull_request template (included with every pull_request)
  5. Request review from one of our maintainers (this should happen automatically via .github/CODEOWNERS).
  6. Get Approval. I'll let you know if there are any changes that are needed.
  7. Merge your changes into kgforge!

Contributing TLDR

  1. Create branch
  2. Add changes
  3. Test locally
  4. Create PR
  5. Get your awesome work reviewed and approved by a maintainer
  6. Merge
  7. Celebrate!

Community Guidelines

  1. Be Kind - Working together should be a fun learning opportunity, and I want it to be a good experience for everyone. Please treat each other with respect.
    - If something looks outdated or incorrect, please let me know! I want to make kgforge as useful as possible.
  2. Own Your Work
    • Creating a PR for kgforge is your first step to becoming a contributor, so make sure that you own your changes.
    • Our maintainers will do their best to respond to you in a timely manner, but I ask the same from you as the contributor.

Submitting issues/bugs

I use GitHub issues to track bugs and suggested enhancements. You can report a bug by opening a new issue new issue Before reporting a bug/issue, please check that it has not already been reported, and that it is not already fixed in the latest version. If you find a closed issue related to your current issue, please open a new issue and include a link to the original issue in the body of your new one. Please include as much information about your bug as possible.

Suggesting enhancements

You can suggest an enhancement by opening a new feature request. Before creating an enhancement suggestion, please check that a similar issue does not already exist.

Please describe the behavior you want and why, and provide examples of how kgforge would be used if your feature were added.

Thank you!