Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a CONTRIBUTING.md file and Makefile to guide new contributors #305

Merged
merged 21 commits into from
Apr 25, 2023
Merged

Add a CONTRIBUTING.md file and Makefile to guide new contributors #305

merged 21 commits into from
Apr 25, 2023

Commits on Apr 21, 2023

  1. 🆕 chore(Makefile): add Makefile with global configuration and help me…

    …ssage
    
    This commit adds a Makefile to the project with global configuration and a help message. The Makefile includes a global configuration for the default goal, export all variables, silent mode, and bash shell. It also includes a help message with instructions on how to use the Makefile.
    ThomasSanson committed Apr 21, 2023
    Configuration menu
    Copy the full SHA
    560ed21 View commit details
    Browse the repository at this point in the history
  2. 🆕 feat(Makefile): add help command

    A new file `.config/make/help.mak` was added to the project, which contains a `help` target that prints a list of available make targets with their descriptions. The `Makefile` was updated to include the `help.mak` file. This makes it easier for developers to understand the available make targets and their purposes.
    ThomasSanson committed Apr 21, 2023
    Configuration menu
    Copy the full SHA
    b422bd0 View commit details
    Browse the repository at this point in the history
  3. 🔧 chore(Makefile): update python_launcher to version 3.10

    🎉 feat(python.mak): add makefile for python virtual environment management
    The python_launcher variable in the Makefile has been updated to version 3.10. This change is made to ensure that the correct version of Python is used for the virtual environment. The python.mak makefile has been added to manage the virtual environment for Python. It includes targets for creating, upgrading, and installing requirements for the virtual environment. Additionally, targets for linting and testing Python scripts have been added.
    ThomasSanson committed Apr 21, 2023
    Configuration menu
    Copy the full SHA
    45d5649 View commit details
    Browse the repository at this point in the history
  4. 🆕 feat(makefile): add yaml makefile

    The yaml makefile is added to the project, which includes targets for bootstrapping and running yamllint. The yaml-bootstrap target installs or upgrades linters, and the yamllint target runs yamllint on the project.
    ThomasSanson committed Apr 21, 2023
    Configuration menu
    Copy the full SHA
    b9f109b View commit details
    Browse the repository at this point in the history
  5. 🎉 feat(molecule.mak): add molecule make targets

    This commit adds a new file `.config/make/molecule.mak` which contains make targets for running molecule commands. These targets include `molecule-bootstrap`, `molecule-test`, `molecule-destroy`, `molecule-converge`, `molecule-reconverge`, `molecule-test-all`, `molecule-destroy-all`, `molecule-test-scenario`, `molecule-destroy-scenario`, `molecule-converge-scenario`, `molecule-dependency`, `molecule-verify`, and `molecule-lint`. These targets allow for easier management of molecule commands and scenarios.
    ThomasSanson committed Apr 21, 2023
    Configuration menu
    Copy the full SHA
    163447f View commit details
    Browse the repository at this point in the history
  6. 🔥 chore(Makefile): add clean and reinitialization targets

    The `clean` target removes all temporary files and directories created during the build process. The `reinitialization` target removes the virtual environment, vendor directory, and all makefiles, returning the collection to its initial state.
    ThomasSanson committed Apr 21, 2023
    Configuration menu
    Copy the full SHA
    722b6c1 View commit details
    Browse the repository at this point in the history
  7. 🔥 chore(.gitignore): add .venv to ignore list

    The .venv directory is added to the ignore list to prevent it from being tracked by git. This directory is used by virtual environments and should not be included in the repository.
    ThomasSanson committed Apr 21, 2023
    Configuration menu
    Copy the full SHA
    85ba8a0 View commit details
    Browse the repository at this point in the history
  8. 🔧 chore(Makefile): remove yaml.mak and molecule-bootstrap target

    📦 chore(requirements): add ansible to requirements.txt and create requirements.dev.txt
    The yaml.mak file was removed as it was no longer needed. The molecule-bootstrap target was also removed as it was not being used. The ansible package was added to requirements.txt as it was required for the project. A new requirements.dev.txt file was created to hold development dependencies such as ansible-lint, yamllint, molecule, molecule-plugins[docker], and docker.
    ThomasSanson committed Apr 21, 2023
    Configuration menu
    Copy the full SHA
    d5254da View commit details
    Browse the repository at this point in the history

Commits on Apr 22, 2023

  1. 🎉 feat(CONTRIBUTING.md): add CONTRIBUTING.md file

    This commit adds a CONTRIBUTING.md file to the repository, which provides guidelines for contributing to the project. The guidelines include instructions for creating issues, forking the project, making changes, testing changes, and making pull requests. The guidelines also include a request for sponsorship.
    ThomasSanson committed Apr 22, 2023
    Configuration menu
    Copy the full SHA
    5051a2e View commit details
    Browse the repository at this point in the history
  2. 📝 docs(CONTRIBUTING.md): fix typos and improve readability

    This commit fixes several typos and improves the readability of the CONTRIBUTING.md file. Changes include fixing grammar and punctuation errors, improving sentence structure, and clarifying instructions. These changes will make it easier for contributors to understand how to contribute to the project and improve the overall quality of the file.
    ThomasSanson committed Apr 22, 2023
    Configuration menu
    Copy the full SHA
    ecb4e58 View commit details
    Browse the repository at this point in the history
  3. 📝 docs(CONTRIBUTING.md): update link to pull request documentation

    This commit updates the link to the pull request documentation to the official GitHub documentation. This will ensure that contributors are directed to the correct documentation and can create pull requests with ease.
    ThomasSanson committed Apr 22, 2023
    Configuration menu
    Copy the full SHA
    760cdda View commit details
    Browse the repository at this point in the history

Commits on Apr 23, 2023

  1. 🔀 merge(python): update python requirements files

    ✨ feat(python.mak): change python requirements file paths
    🆕 chore(python): add requirements.dev.txt file
    The python requirements file paths have been updated to match the new file locations. The requirements.txt file has been updated to include ansible>=2.7. A new requirements.dev.txt file has been added to include development dependencies such as ansible-lint, yamllint, molecule, molecule-plugins[docker], and docker.
    ThomasSanson committed Apr 23, 2023
    Configuration menu
    Copy the full SHA
    a29b98d View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    4834783 View commit details
    Browse the repository at this point in the history
  3. 🐛 fix(CONTRIBUTING.md): add sudo to apt update command

    The sudo command was missing from the apt update command, which could cause issues with updating the package list.
    ThomasSanson committed Apr 23, 2023
    Configuration menu
    Copy the full SHA
    9c08ec1 View commit details
    Browse the repository at this point in the history
  4. 📝 docs(CONTRIBUTING.md): add instructions for contributing with Gitpod

    This commit adds a new section to the CONTRIBUTING.md file that explains how to contribute to the project using Gitpod, a cloud-based development environment platform. The section includes step-by-step instructions for creating a Gitpod workspace, making changes, committing them, and creating a pull request. This addition aims to make it easier for contributors to get started with the project without having to set up a local environment.
    ThomasSanson committed Apr 23, 2023
    Configuration menu
    Copy the full SHA
    230fa1b View commit details
    Browse the repository at this point in the history
  5. 📝 docs(CONTRIBUTING.md): update sponsor links

    The sponsor links have been updated to include both GitHub and Patreon options. This will make it easier for contributors to support the project in a way that is most convenient for them.
    ThomasSanson committed Apr 23, 2023
    Configuration menu
    Copy the full SHA
    6ebc44d View commit details
    Browse the repository at this point in the history

Commits on Apr 24, 2023

  1. 📝 docs(CONTRIBUTING.md): add instructions to test changes with Molecule

    Added instructions to test changes with Molecule before committing. The instructions include how to test a specific distribution, set `distro`, optionally `tag`, and `namespace`. This ensures that changes are tested and working correctly before being pushed to the repository.
    ThomasSanson committed Apr 24, 2023
    Configuration menu
    Copy the full SHA
    236a6c1 View commit details
    Browse the repository at this point in the history
  2. 🎉 feat(docker.mak): add docker-build and docker-lint targets

    🎉 feat(.gitpod.Dockerfile): add Dockerfile for Gitpod
    🎉 feat(.gitpod.yml): use custom Dockerfile for Gitpod image
    🎉 feat(Makefile): include docker.mak in Makefile
    The Dockerfile and docker.mak files were added to the project to support building and linting Docker images. The .gitpod.yml file was updated to use the custom Dockerfile for the Gitpod image. The Makefile was updated to include the docker.mak file.
    ThomasSanson committed Apr 24, 2023
    Configuration menu
    Copy the full SHA
    851a78f View commit details
    Browse the repository at this point in the history
  3. 🐛 fix(.gitpod.yml): correct typo in bootstrap task name

    The typo in the bootstrap task name has been corrected from 'boostrap' to 'bootstrap'. This ensures that the task runs correctly when executed.
    ThomasSanson committed Apr 24, 2023
    Configuration menu
    Copy the full SHA
    6b6d98c View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    866e603 View commit details
    Browse the repository at this point in the history

Commits on Apr 25, 2023

  1. 📝 docs(CONTRIBUTING.md): update contributing guide

    This commit updates the contributing guide to provide clearer instructions on how to contribute to the project. It also adds a section on how to use Gitpod for a cloud-based development environment. Additionally, it adds a reminder to consider sponsoring the maintainer via GitHub or Patreon.
    ThomasSanson committed Apr 25, 2023
    Configuration menu
    Copy the full SHA
    a14a145 View commit details
    Browse the repository at this point in the history