Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 4.09 KB

CONTRIBUTING.md

File metadata and controls

74 lines (49 loc) · 4.09 KB
Raw

Welcome to PyHTools contributing guide

Thank you for investing your time in contributing to project! ✨.

Contribution workflow

  • Opening an issue
  • Creating a PR
  • Reviewing
  • Merging the PR.

Contributions Accepted

  • Fix bug
  • Add New Feature
  • Enhance existing functionality
  • or any other contribution which can help to enhance this project

Avoid Below Contributions

  • README updates
  • Wordlists
  • HowTos

These topics can be discussed using Discussions Tab

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Issues

Create a new issue

If you spot a problem, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. We don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes in the Project Code Locally

  • Fork the Repo
  • Clone to local machine
  • Update Source Code

Commit your update

We accept signed commits which provide valid description about their contribution to the project.

Pull Request

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

  • Open a PR and link PR to issue if you're working on an issue.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a team member will review your proposal. We may ask questions or request for 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 🎉🎉