Contributions are welcome to the project's public repo all year long in accordance with the projects guidleines, purpouse and goals.
All contribution is welcome (adding features✨, bug fix🔧, bug report🐛, design✒️, documentation📝, fixing typos ...etc). but we prefer quality over quantity so avoid making 5 PRs to fix 5 obvious grammar mistakes just to get the challenge completed faster (it may not be merged).
This project is not limited in time by it's participation in events such as hacktoberfest and will still be active after that.
Hacktoberfest is a month-long celebration of open source organized by DigitalOcean Inc. Whether you’re a developer, student learning to code, event host, or company of any size, you can help drive growth of open source and make positive contributions to an ever-growing community. All backgrounds and skill levels are encouraged to complete the challenge.
- Learn about Hacktoberfest Particiaption
- Be sure to sign up on the official Hacktoberfest website for your pull requests to count.
- You can sign up anytime between October 1 and October 31.
- Pull requests can be made in any GitHub-hosted repositories/projects.
- Cut the maintainers some slack. They work hard and have other things to deal with outside this project. So don't be impatient or spammy.
- Make sure your contribution alligns with the Hacktoberfest Suality Standards
- Do not open spammy Pull Requests. We all like swag but it's not a reason for mediocre contributions or spammy ones, this may give less chances to total biginners.
- Always check repo's open issues to avoid duplicates, conflict and ambiguous work.
- Open a new issue stating the subject of your upcoming contribution if no already existing open issue is related to the subject.
- If it's a one-time issue, ask a maintainer to assign you to the issue before starting to work on it.
- Always make sure your own forked repo is up to date with the original repo.
- If the PR doesn't align with the Hacktoberfest rules and/or the repo's rules then you'll be asked to make changes, otherwise it will be marked as invalid. ❌ and won't count in the challenge.
- Make sure you give your PR a clear discription and meaningful title of your contribution are requested.
- Fork this original repo to your own account.
- Clone the project to your local machine or in the browser.
- Create a new branch for you contribution and name it relatively (e.g: dark-theme-feature or contributors-counter)
- Document your code, no one has time to figure out the meaning of your ancient rituals codes ...
- Make sure your contribution don't break existing features.
- Link the issue(s) you worked on in your pull request description.
- Use visual displays (screenshots, pictures, videos) to express the new changes you added in your PR if you contributed to an issue that affects the looks, functions of the project.
- Issues are labbeled to make it easier for contributors/mantainers identify them.
- Always check the existing issues to avoid conflict and duplicates.
- Request to be assigned to an issue before you start working on it.
Contributions to this project are availble publically to anyone accessing the repo, the project's live website or posts on social media regarding this project.