GUIDELINES.md

Contribution Guidelines

Excited that you're interested in contributing to this project! Here are some guidelines to help you get started.

How to Contribute

1. Fork the repository
2. Create a new branch with a descriptive name (git checkout -b add-nullpointer-mistake or git checkout -b add-modifier-extension-learning)
3. Add your mistake or learning in a new file in the mistakes or learnings folder, respectively
4. Follow the existing naming convention: DescriptiveName.kt
5. Include both the mistake and the solution (for mistakes) or the learning and its application (for learnings) in your file, with clear comments explaining both
6. Update the README.md to include your new file in the "Mistakes to Avoid" or "Learnings to Embrace" section
7. Commit your changes (git commit -am 'Add NullPointer mistake and solution' or git commit -am 'Add Modifier extension learning')
8. Push to your branch (git push origin add-nullpointer-mistake or git push origin add-modifier-extension-learning)
9. Create a new Pull Request

What to Contribute

• Real-world Kotlin mistakes you've encountered
• Solutions and best practices for avoiding these mistakes
• Clear explanations of why the mistake occurs and how the solution fixes it
• Valuable Kotlin learnings that could benefit others
• Practical applications and examples of these learnings

Code Style

• Follow Kotlin coding conventions
• Use Something where ever possible
• Use clear and concise variable names
• Include comments to explain complex parts of your code

Writing Style

• Be clear and concise in your explanations
• Use simple language that beginners can understand
• If using technical terms, provide brief explanations or links to resources

Remember

• No mistake is too small or too "obvious" to contribute
• Your recent learnings as a beginner are valuable for other newcomers
• Mistakes and learnings from experienced developers can help others understand complex scenarios

Thank you for contributing!