Welcome to StackOverflow Mining contributing guide #

Thank you for investing your time in contributing to our project! :sparkles:.

Read our Code of Conduct to keep our community approachable and respectable.

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.

We categorize our issues avaluating two metrics:

Getting started#

To understand project’s file structure take a look at Getting Started.

Issues#

Create a new issue#

If you identify a problem with the docs or code, check to see if a problem already exists.

If a related issue does not exist, you can open a new issue, as a rule two types of issue form are used.

they are:

Solve a problem#

Please review our existing issues to find one that interests you. You can narrow your search using tags as filters. See Labels for more information. As a general rule, we do not attribute problems to anyone. If you find an issue to resolve, you can open a PR with a fix.

make branches#

The original repository must be forked. As a rule, creations of branches in the original fork will not be accepted.

Commit your update#

Commit the changes once you are happy with them. Don’t forget to follow the commit policy used in this project.

Visit commit politics for more information!

development politics#

The code must follow the guidelines found in the official documents of each technology used in this project.

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 :tada::tada: The GitHub team thanks you :sparkles:.

Once your PR is merged, your contributions will be publicly visible on the GitHub docs.

Now that you are part of the GitHub docs community, see how else you can contribute to the docs.