Firstly, a huge shoutout to you for even considering contributing to GitLexJS! 🎉 It's enthusiastic individuals like you that make GitLexJS an outstanding tool.
- Beginners: New around here? No worries! Begin by delving into issues tagged as
good first issueorbeginner-friendlyto get your feet wet. 🚀 - Bug Reports: 🔍 Identified a bug? Firstly, sift through existing issues to ensure it's not a known issue. If it's new, craft a detailed issue enumerating the bug and the steps to reproduce it.
- Feature Requests: 💡 Have an innovative idea? Kickstart by initiating an issue to converse about the prospective feature before diving deep into coding.
- Setup your Environment: 🛠️ Clone the repository, immerse yourself, and ascertain you're equipped with all requisites.
- Branch Out: 🌲 Always cultivate your magic in a new branch.
- Craft Changes: ✍️ Design your modifications and immortalize them in commits. Do keep in mind the commit message conventions.
- Test: 🧪 Assure your innovations blend harmoniously without introducing chaos.
- Raise a Pull Request: 💌 Once content with your masterpiece, propel your branch to your fork and pen down a pull request targeting the
developbranch of the primary repository. Enlighten us with a vivid description of your endeavors. - Engage in Review: 👀 Await the inspection of your pull request. Engage in the conversation and fine-tune if necessary.
- Keep your tales of code succinct. 🧵 Each commit should encapsulate a single logical transformation.
- Employ an authoritative tone: "Add feature", not "Added feature" or "Adds feature".
- Embark on the commit message journey with an uppercase letter.
- Abstain from concluding the commit message with a dot.
Eager to test? Hang tight, we're gearing up for it. Testing guidelines coming soon! ⏳
Your insights are our treasure! 🎁 If you have a brainstorm for enhancing any facet of GitLexJS, don't hesitate to voice it by inaugurating an issue. Let's sculpt brilliance together!