Skip to content

Contributing to redhat-cop/rhel-good-practices

Welcome to the redhat-cop/rhel-good-practices repository! We appreciate your interest in contributing. This guide will walk you through the entire process of contributing to the project, from setting up your environment to submitting your changes.

Table of Contents

  1. Getting Started
  2. Setting Up Your Environment
  3. Making Changes
  4. Creating a Pull Request
  5. Code Review Process
  6. Additional Resources

Getting Started

Before you start contributing, make sure you have the following: - A GitHub account. - Basic knowledge of Git and GitHub workflows. - Familiarity with the project's purpose and guidelines (check the README).

Setting Up Your Environment

  1. Fork the Repository:
  2. Go to the repository page.
  3. Click the "Fork" button at the top right to create a copy of the repository under your GitHub account.

  4. Proceed and create the fork.

  5. Clone Your Fork:

  6. Clone your forked repository to your local machine (replace YOUR-USERNAME with your GitHub username): 

    git clone https://github.com/YOUR-USERNAME/rhel-good-practices.git
cd rhel-good-practices

  7. Set Upstream Remote:

  8. Add the original repository as an upstream remote to sync changes: 

    git remote add upstream https://github.com/redhat-cop/rhel-good-practices.git

  9. Sync Your Fork:

  10. Fetch the latest changes from the upstream repository: 
    git fetch upstream

  11. Merge the changes into your main branch: 

    git checkout main
git merge upstream/main

  12. Create a New Branch:

  13. Create a new branch for your changes: 
    git checkout -b your-branch-name

Making Changes

  1. Make Your Changes:
  2. Make the necessary changes to the code or documentation.

  3. Follow the project's coding standards and guidelines.

  4. Commit Your Changes:

  5. Stage your changes: 
    git add .

  6. Commit your changes with a clear and descriptive commit message: 

    git commit -m "Your descriptive commit message"

  7. Push Your Changes:

  8. Push your changes to your forked repository: 
    git push origin your-branch-name

Creating a Pull Request

  1. Open a Pull Request:
  2. Go to your forked repository on GitHub.
  3. Click the "Compare & pull request" button.
  4. Describe Your Changes:
  5. Provide a clear title and description for your pull request.

  6. Reference any related issues using #issue-number.

  7. Submit the Pull Request:

  8. Click "Create pull request" to submit your changes for review.

Code Review Process

  • Maintainers will review your pull request and may request changes.
  • If changes are requested, make the necessary updates and push them to your branch. The pull request will automatically update.
  • Once your pull request is approved, it will be merged into the main repository.

Additional Resources

Thank you for contributing to redhat-cop/rhel-good-practices! Your efforts help improve the project for everyone. If you have any questions, feel free to reach out to the maintainers.

Happy contributing! 🚀