Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 2.75 KB

CONTRIBUTING.md

File metadata and controls

46 lines (27 loc) · 2.75 KB
Raw

Contributing to the "Fork, Commit, Merge" Repository 🚀

First and foremost, we appreciate your interest in contributing! 🙌

This document outlines our guidelines for participating in this project. These are more like friendly suggestions than strict rules. Feel free to propose changes to this document through a pull request. 📝

Note: You don't need to seek permission to tackle an issue or get assigned. These issues are open to new contributors. The actions-user bot will reset the file to its previous state for the next contributor after your commit is merged. So, you can dive right into the issue without delay! 🏊‍♂️

Code of Conduct 🤝

This project, along with everyone involved, adheres to the Code of Conduct. When participating, you are expected to uphold this code. If you encounter inappropriate behavior, please report it to niko.hoffren@gmail.com. 🚫

How Can I Contribute? 🤔

Reporting Bugs 🐞

In this section, we'll walk you through submitting a bug report for this project. Following these guidelines helps maintainers and the community understand your report, reproduce the issue, and identify related reports. 🕵️‍♀️

  • Choose a clear and descriptive title for your issue to pinpoint the problem. 📢
  • Provide a detailed account of the exact steps that reproduce the issue. 📋

Suggesting Enhancements 💡

This section guides you through submitting an enhancement suggestion for this project, which can range from entirely new features to minor improvements in existing functionality. These guidelines help maintainers and the community grasp your suggestion and make decisions regarding its implementation. 🛠️

  • Use a clear and descriptive title for the issue to identify the suggestion. 🚀
  • Furnish a step-by-step description of the suggested enhancement, including as many details as possible. 📈

Your First Code Contribution 👩‍💻

Not sure where to start with your contribution to this project? You can begin by exploring the good-first-issue and help-wanted issues: 🚧

  • good-first-issue - These issues typically require just a few lines of code and perhaps a test or two. 🛠️
  • help-wanted - These are slightly more involved than good-first-issue tasks. 💪

Pull Request Process 🚢

  1. Start by forking the repository and creating your branch from the main branch. 🍴
  2. If you've added code that needs testing, include tests. 🧪
  3. If necessary, update the documentation or README. 📖
  4. Ensure that the test suite runs without issues. ✅
  5. Finally, submit your pull request! 🎉

You can ⭐ the repo as well! 🔥

Now you're all set to contribute effectively and make a positive impact on our project! 🙏👏