65 lines (48 loc) · 1.42 KB

Contributing to Konoha Land API

Thank you for your interest in contributing to Konoha Land API! 🎉

How to Contribute

Reporting Bugs

If you find a bug, please open an issue with:

Clear description of the bug
Steps to reproduce
Expected vs actual behavior
Environment details (Node version, OS, etc.)

Suggesting Features

We welcome feature suggestions! Please open an issue with:

Clear description of the feature
Use case and benefits
Possible implementation approach (if you have ideas)

Code Contributions

Fork the repository

Create a feature branch:

git checkout -b feature/your-feature-name

Make your changes
Test your changes:
```
npm run build
npm run start:dev
```

Commit your changes:

git commit -m "Add: your feature description"

Push to your fork:

git push origin feature/your-feature-name

Open a Pull Request

Code Style

Follow TypeScript best practices
Use meaningful variable and function names
Add comments for complex logic
Keep functions small and focused
Write self-documenting code

Testing

Test your changes locally before submitting
Ensure the build passes: npm run build
Test API endpoints manually or with tools like Postman

Questions?

Feel free to open a discussion or issue if you have questions!

Thank you for contributing! 🙏