github.com/sharovik/devbot@v1.0.1-0.20240308094637-4a0387c40516/CONTRIBUTING.md (about)

     1  # Welcome to contributing guide
     2  Thank you for investing your time in contributing to devbot project! 
     3  Read our [Code of Conduct](CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
     4  In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
     5  
     6  # Getting started
     7  
     8  ## Issues
     9  If you spot any problem related to the devbot core functionality, [search first if this issue already exists and open](https://github.com/sharovik/devbot/issues). If a related issue doesn't exist, you can open a new issue.
    10  
    11  Please, describe the context and type of the problem you spoted. If you can, describe the scenario, how to reproduce the issue. If it is possible, provide the screenshots.
    12  
    13  ## Solve the issues
    14  [Scan through our existing issues](https://github.com/sharovik/devbot/issues) to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. As a general rule, 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.
    15  
    16  ## Add Changes
    17  1. Fork the repository
    18  2. Install all dependencies, described in the [prerequisites page](documentation/prerequisites.md) and setup devbot locally
    19  4. Create a working branch and start with your changes
    20  5. Commit the changes
    21  
    22  ## Pull-Requests
    23  When you're finished with the changes, create a pull request, also known as a PR.
    24  
    25  1. Link PR to issue if you are solving one
    26  2. Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge. Once you submit your PR, a devbot team member will review your proposal. There may be questions asked or additional information requested.
    27  3. We may ask for changes to be made before a PR can be merged. You can make any other changes in your fork, then commit them to your branch.
    28  
    29  ## Your PR is merged 🎉
    30  Once your Pull-request gets approved, we will merge it into our repository. And you will see your changes in our repository
    31  
    32  
    33  
    34  
    35