The main goal of "The Duck Gallery" is to propose an easy and fun way to make your first contribution on an open source project.
Here the official website: https://theduckgallery.zenika.com
It's open to everyone. Happy Hacktoberfest !
Contributing
First of all, to contribute, you must be agree with our code of conduct.
Then it's time to add your duck ;)
The easy way to contribute
Here you just need a GitHub account (don't forget to register to Hacktoberfest if you want a PR count)
Then watch the video and follow the steps:
The developer way to contribute
- Go to https://pimpmyduck.zenika.com and create your own duck
- Export it to an image (use the download button)
- Fork this repository and clone it
- Add your image into the
ducks/
folder, with your GitHub username as filename (ex:your-username.png
) - Into the
contributors.js
file, add a line with your GitHub username and a short message
{ username: 'your-username', message: 'Say something kind or fun' },
- Commit and push your modifications
- Create a PR
That's it 🎉 We will review it and merge it if everything is OK 👍
Once merged, you will be able to see it here:
https://theduckgallery.zenika.com
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 have added your image of the duck downloaded from https://pimpmyduck.zenika.com
- You have not changed the image of the duck.
- The image filename must be your GitHub username (ex:
your-username.png
). - You are using your own GitHub user and it's the same as the PR author.
- Into the
contributors.js
file, the message must be short and respect the code of conduct.
License
This project is Apache-2.0 licensed.
Copyright © 2020 Zenika.