Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (57 loc) · 3.91 KB

CONTRIBUTING.md

File metadata and controls

83 lines (57 loc) · 3.91 KB
Raw

Contributing to Packit

Thank you for considering to contribute to Packit! This file will help you in understanding how to contribute to Packit.

If you want to add support for a new package, a new package version or some other change to the list of available packages, please take a look at our core repository.

Getting started

The steps below guide you through the process of forking the repository, commiting changes and opening a pull request.

  1. Fork the repository
    Click the Fork button on the top-right corner of the repository page. This creates your own copy of the Packit repository, where you can make your changes.

  2. Clone your fork locally
    To start working, you need the repository on your local machine. To do this, you need to clone it.

    Run the commands below to clone your fork locally, replace <your-username> with your GitHub username.

git clone https://github.com/<your-username>/packit.git
cd packit
  1. Create a new branch
    Now you have a local copy of the repository, you need to create a new branch where you can make your changes.

    Please use a name which describes your changes for the branch.
git checkout -b <branch-name>

  1. Add your changes
    On the new branch, you can now add your own changes.

  2. Pushing your changes
    After you added your changes, you first need to create a commit and push your changes.

    Please ensure your commit message describes the changes correctly

    You can add, commit and push by running the command below:

git add .
git commit -m <message>
git push origin <branch-name>
  1. Open a pull request
    Now all your changes are on your own fork of the Packit repository, you can open a pull request to submit your changes to the official Packit repository.

    To create a pull request you need to go to the official repository (https://github.com/pack-it/packit), at the top a yellow banner is shown with the button Compare & pull request. Click on this button and ensure the base branch is set to main and the compare branch is set to the branch you created.

    Ensure the titles describes clearly what changes you made, ideally this matches with the commit naming conventions. Add a good description, including all details of your changes.

    After you have done all steps above, click on the Create pull request button. Your pull request is now created and one of the Packit maintainers will review it as soon as possible.

License

This project is licensed under the GNU General Public License v3.0. See LICENSE for the full license.

By contributing to this project, you agree that your contributions will be licensed under the same license.

You must ensure that your contributions are your own original work or that you have the right to submit them under the project's license.

Types of contributions

Feature request or implementation

You're always welcome to submit feature requests, this can be in the form of a GitHub issue, or as a pull request. Please note that we cannot always accept all feature requests, so we advice you to first create an issue before implementing your idea.

We're open to all new ideas and improvements and will review your request as soon as possible.

Bugs

If you found a bug, make sure to create a GitHub issue for it. We would also really appreciate it if you decide to implement a fix and create a pull request for it. We will make sure to review it as soon as possible.

Documentation improvements

You're always welcome to improve our documentation! You can just create a pull request with your changes, we will take a look at it as soon as possible.

Available packages changes

If you want to add support for a new package, a new package version or some other change to the list of available packages, please take a look at our core repository.