🎉 We're participating in Hacktoberfest 2024! 🎉
Welcome to Hacktoberfest 2024 brought to you by Chimoney! This is your complete guide to contributing to Chimoney's open-source projects.
⭐️ If you're new to Hacktoberfest, you can learn more and register to participate here. Registration is from September 26th - October 31st.
You can view this README in your preferred language:
Developer Toolkit. Discord Community · API Use Cases. Twitter (X) · Email
## Table of Contents - [Table of Contents](#table-of-contents) - [Introduction](#introduction) - [Chimoney Rewards](#chimoney-rewards) - [Obtaining API Keys](#obtaining-api-keys) - [Project Setup](#project-setup) - [Submission Process](#submission-process) - [Contribute via Gitpod](#contribute-via-gitpod) - [Mentorship](#mentorship) - [License](#license) - [Contact \& Resources](#contact--resources) - [A Big Thank You to All Our Awesome Contributors ❤️](#a-big-thank-you-to-all-our-awesome-contributors-️) ## Introduction Join us for a month of coding, learning, and contributing to Chimoney's open-source projects! We have also introduced a [Quickstart Guide](submissions/Quickstart_Guide.md) to help you get started with integrating the Chimoney API into your applications. ## Chimoney Rewards At Chimoney, we value your contributions, and to show our appreciation, we will be offering Chimoney rewards for pull requests that are successfully merged into our open-source projects. - For every substantial merged Pull Request (PR), contributors will receive a Chimoney reward of $10, sent via email. Please note that minor contributions, such as typo fixes or minor fixes to other user contributions and single lines fixes will not qualify for rewards. Some issues may have specific reward amounts, which are clearly indicated in the issue labels. The amount displayed on the label reflects the payout for those specific, more complex issues. - Every contributor will receive a digital badge as a token of recognition for their contribution. - Contributors with up to 4 merged PRs will also receive a Chimoney t-shirt! Since we have a limited supply, t-shirts will be distributed based on the quality and impact of contributions. ## Obtaining API Keys 1. **Sign up for a Chimoney Developer Account:** See the Sandbox Access Instruction [here](https://sandbox.chimoney.io/developers). If you don't already have one, you'll need to sign up for a Chimoney developer account sandbox access at [sandbox.chimoney.io](https://chimoney.readme.io/reference/sandbox-environment). - You can also check out this article on how to obtain API keys [here](https://community-chimoney.hashnode.dev/getting-started-with-chimoneys-api-chiconnect). 2. **Create a New Application:** Once logged in, navigate to your developer dashboard and create a new application. This will generate your API key for you. 5. **Start Contributing:** With your API keys in place, you're ready to start contributing! ## Project Setup This repository contains various small projects, each using different stacks and frameworks. The code for each project is located in its own directory within the [submissions](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions) folder. You are welcome to contribute to any project or suggest your own. Here's how to get started: - Explore the list of available [issues](https://github.com/Chimoney/chimoney-community-projects/issues) in Chimoney community projects. You can also create an issue with a project/suggestion you would like to work on. - Select an issue and ask to be assigned to it. Tag @phyleria - After implementing your contribution, submit a pull request, ensuring it follows our contribution guidelines. ## Submission Process - For **technical writers**, please submit your PR within the `Articles` folder. *Instructions are included [here](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/Articles)* - For **other contributions**, submit your PR in the general `submissions` folder. Please make sure to follow our formatting guidelines, and provide relevant documentation to ensure smooth and efficient reviews of your pull requests. ## [Contribute via Gitpod](https://www.gitpod.io/docs/introduction) ## Mentorship New to open source? No problem! We provide mentorship to help you get started. Simply join us on [Discord](https://discord.gg/Q3peDrPG95) to connect with a mentor and begin your journey. ## License This project is licensed under the [MIT License](https://github.com/Chimoney/chimoney-community-projects/blob/main/LICENSE). ## Contact & Resources If you need assistance or have questions, please contact us at [community@chimoney.com](mailto:community@chimoney.com). For more resources and information, visit our [website](https://chimoney.io/) and [documentation](https://chimoney.readme.io/reference/introduction). We can't wait to see your contributions to Hacktoberfest 2024! Happy coding! 🚀 ## A Big Thank You to All Our Awesome Contributors ❤️ ![Contributors](https://contrib.rocks/image?repo=Chimoney/chimoney-community-projects)