Happy Hacktoberfest!

Quick start

Welcome to the Happy Hacktoberfest repository!The python package hacktoberfest_jems is a wishing box from all contributors.

With Docker:

pre-requisite: You need to have docker installed. You can find the documentation here https://docs.docker.com/install/
run the following command:

 sudo docker run amagash/dmichelle/amagash_hacktoberfest:latest

With pip:

To install the current release of hacktoberfest_jems:

> pip install hacktoberfest_jems

Now you can read a contributor's wish:

> hacktoberfest_jems

# John Doe wishes you a very happy Hacktoberfest!

To randomly pick a new wish, simply rerun the previous command. This is what you should see:

Contribution

This repository is here for you to experiment with Github and learn how to make your first Pull Request (PR).

Fork this project

This step will create a copy of this repository (red line) in your library of repositories. At this point, you will make your contribution in your forked repository (green line).

Go to your repositories to check if the repository Happy Hacktoberfest has been properly forked in your library.

Open your forked Happy Hacktoberfest repository (or clone it). In the file hacktoberfest_jems/data/contributors.json, add your Github username and a short message to celebrate Hacktoberfest.

    {
        "author":"your-github-username", 
        "wish":"your_message"
    },

Your message will be displayed as follows : your-github-username wishes you your-message For example :

    {
        "author":"John Doe", 
        "wish":"a very happy Hacktoberfest!"
    },

Would display: John Doe wishes you a very happy Hacktoberfest!

Commit your modifications (and push if you cloned it)

This step will send your modifications to the main branch of your forked repository (green line).

Create a PR. From your repository, click on the Pull requests tab and click on the button "New pull request". You should see this repository as base: Amagash/Happy_Hacktoberfest and your repository as compare: your_username/Hacktoberfest.

This will create a request from your forked repository (green line) to merge your modifications into this repository (red line).

Your modifications will be reviewed by a project maintainer and will be merged if compliant with the following conditions.

Be careful, your PR must respect the following conditions:

Your contribution must respect the code of conduct.
It's your first PR to this repository.
You are using your own GitHub username and it's the same as the PR author.
Into the contributors.json file, the message must be short and respect the code of conduct.

If everything is ok, your PR will be merged.

Congratulations! 🎉 You’ve just submitted your first PR!

Now that you know the basics, you can search for other projects to contribute to. You can start looking for other projects to contribute here => https://github.com/topics/hacktoberfest

Happy Hacktoberfest and Happy contributing!

amagash / happy_hacktoberfest Goto Github PK