Skip to content

Latest commit

 

History

History
77 lines (43 loc) · 4.3 KB

CONTRIBUTING.md

File metadata and controls

77 lines (43 loc) · 4.3 KB
Raw

Welcome to GMP-Featurizer contributing guide

Thank you for interesting in investing your time and contributing to our project!

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README and the associated short paper.

Please refer to the examples for the functionalities of this

Issues

Create a new issue

If you spot a problem with the package, please look through if it's mentioned in any of the issues. If a related issue doesn't exist, you can open a new issue in the repository.

Feature request

You are welcomed to submit feature requests by opening up new issues. We will try our best to meet everybody's need. In the issue, please describe your request clearly, and tell us why you think such feature would be a good addition to the package

Solve an issue

Scan through our current issues to find one that interests you. We don’t assign issues to anyone, so if you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

  1. Fork the repository.
  1. Create a working branch and start with your changes.

Commit your update

Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process:zap:.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The GMP-Featurizer team thanks you ✨.

Community Guidelines

We value a friendly and inclusive community. Please adhere to the following guidelines when participating:

  • Be respectful and considerate to others, regardless of their background or experience level.
  • Avoid offensive, discriminatory, or inappropriate language and behavior.
  • Engage in constructive discussions and provide helpful feedback.
  • Help others and contribute positively to the community.

Contact

If you have any questions, concerns, or suggestions, please reach out to us via ray.lei@tri.global.

Thank you for your interest in contributing! We look forward to your valuable contributions.