In this post I'll share a bit about my progress in Hacktoberfest ๐. At the start I set some goals and so far I have 4 PRs awaiting for approval (in the review period), so I need four more to complete my goal. So far it has been difficult in some areas, but most have to do with time constraints. The other issues are usually finding something I want to work on, that isn't already taken.
Before I show my PRs, have a look at EddieBot if you want to make some open source contributions. I'm a maintainer so I want to help anyone new to open source settle in, and feel comfortable to contribute ๐. These are good first issues since they should all be simple and easy to get started.
EddieHubCommunity
/
EddieBot
Inclusive words Discord bot (no more "hey guys")
EddieBot
The official EddieBot for the EddieHub Discord server. Join us at Discord today!
Features
- Checking peoples' messages for inclusive language.
Config / Secrets environment variables
Copy .env.example to .env and add your private information
Note: never commit this file, it is ignored by Git
# .env file
# required: discord API token
DISCORD_TOKEN=
# required: mongo URL connection string
EDDIEBOT_MONGO_CONNECTION_STRING=
# optional
DEBUG_HOOK=
# required: discord server id
HOME_GUILD="699608417039286293"
# optional
NODE_ENV="development"
# required: channel id for logs
ADMIN_CHANNEL=
Installation
1. Start by making a fork of the repository. Click on the "Fork" symbol at the top right corner.
2. Clone your new fork of the repository:
SSH Github Docs
$ git clone git@github.com:EddieHubCommunity/EddieBot.git
note: recommended
GitHub CLI
$ gh repo clone EddieHubCommunity/EddieBot
HTTPS
$ git clone https://github.com/EddieHubCommunity/EddieBot.git
3. Set upstream command:
git remote add upstream https://github.com/EddieHubCommunity/EddieBot.git
4. Navigate to the new project directory:
cd EddieBot
5. Createโฆ
My PR's ๐ฏ
Here is the list:
- docs(faq): add Finding Open Source Projects
- feat: add list of technologies used for Projects
- docs(features): add description to server status
- build: add LightHouse Check action
You can probably tell a pattern on all those PRs... yes, they are all made to repositories under the Eddie Jaoude Community organization ๐ . I still haven't ventured out and contributed to other projects, and I want to try and improve this. The reason is to get out of my comfort zone. I know these projects pretty well so it was easier to work on.
Some tips โ๏ธ
There were a couple of things I always keep in mind when making a PR which is:
- Add keywords to link issues like
closes: #91 - Add screenshots in case the change is UI based or there is an example you can show
- Explain why you did something a certain way if that is not clear by the changes and the linked issue. Having links to docs or something else that help explain that decision is important, imo.
Also, only four of the PRs on the image count since the others were for test purposes or syncing the fork.
Conclusion ๐
I want to set a new goal: make one PR on a completely new project ๐!
I'm very happy to be participating in this event, even if I struggle to keep up on news and Discord chats every day. I found YouTubers giving out awesome tips, Twitch live streams with live coding to solve issues, and a whole community supporting open source (e.g. the contributions to forem). I love this type of content ๐ฏ and want to support it and share it so that everyone that doesn't know about it, learns about it!
We all live to share knowledge... and well, links to resources ๐. So here you go, a small list of awesome content that helped me:
Top comments (3)
Awesome post!
Thank you Eddie โบ
excelent tips, i have a javafx aplication dinawall in my github repo is a dinamic wallpapers application for linux and macos,