Hello and welcome! We're excited to have you here. This repository marks the beginning of our journey, and we are thrilled to have contributors like you join us.
This is the first project of our organization. Our goal is to π.
We welcome contributions from everyone! Here are a few ways you can get started:
- π Report Bugs: Found a bug? Please create an issue and we'll address it.
- π‘ Suggest Features: Have an idea to improve the project? Let us know by opening a feature request.
- π§ Submit Pull Requests: Ready to contribute code? Fork the repository, make your changes, and submit a pull request.
To keep our commit history clean and meaningful, please use the following commit message types:
- [Add]: For adding a new feature.
- Example:
[Add]: User authentication feature
- Example:
- [Update]: For updating an existing feature or part of the code.
- Example:
[Update]: Enhanced login security
- Example:
- [Fix]: For fixing bugs or issues.
- Example:
[Fix]: Resolved signup form validation
- Example:
- [Remove]: For removing features or files.
- Example:
[Remove]: Deprecated API endpoint
- Example:
- [Temp]: For temporary changes that will be removed later.
- Example:
[Temp]: Add debug logs for testing
- Example:
- [Wip]: For work that is in progress.
- Example:
[Wip]: Refactoring user profile module
- Example:
- [Add] and [Fix] are essential and should definitely be kept as they cover adding new features and fixing issues.
- [Update] is useful for non-bug changes to existing features.
- [Remove] is good for tracking deletions.
- [Temp] is helpful for marking temporary changes, but ensure these are reviewed and removed promptly.
- [Wip] is useful for ongoing work, but it's good practice to complete tasks before committing. Use sparingly to avoid clutter.
Feel free to suggest additional commit message types if you think they are necessary!
If you have any questions or need further assistance, feel free to reach out to us at our π§ Gmail.
Thank you for being part of our community! We look forward to working with you.