Merge pull request #5 from solguruz/ref/update-readme-with-license-and-contributions

refactor: update readme with license and contributions

Author: mihirjsolguruz

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at developer@simform.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+## Git Workflow & Contribution Guidelines
+
+### Branching Strategy
+
+We use GitHub for version control with the following branch structure:
+
+- `master`: Production-ready code
+- `develop`: Integration branch for features
+- `feature/[feature-name]`: For new features
+- `bugfix/[bug-description]`: For bug fixes
+- `hotfix/[hotfix-description]`: For urgent production fixes
+
+### Pull Request Process
+
+1. Create a branch from `develop` for your task
+2. Make your changes and test thoroughly
+3. Push your branch and create a Merge Request to `develop`
+4. Ensure CI passes and request reviews
+5. Address review comments
+6. Request for review and merge the PR
+
+### Commit Guidelines
+
+- Use clear, descriptive commit messages
+- Reference issue numbers in commits and PRs
+- Keep commits focused on single logical changes
+
+## How to Contribute
+
+1. Understand the project structure and coding standards
+2. Pick an issue from the issue tracker or create a new one
+3. Follow the Git workflow described above
+4. Ensure your code passes all tests
+5. Submit a Pull Request with a clear description of changes
+
+We appreciate your contributions to make this skelter project even better!

LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 SolGuruz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -266,39 +266,23 @@ visual changes during development.
 For more details, refer to the **Technical Document on Golden Test Cases** and **alchemist**
 library.
 
-## Git Workflow & Contribution Guidelines
+## 🤝 Contributing
 
-### Branching Strategy
+We welcome contributions! If you find a bug, want to add a feature, or improve the documentation, feel free to create an issue or submit a pull request.
 
-We use GitHub for version control with the following branch structure:
+Please follow our [CONTRIBUTING.md](./CONTRIBUTING.md)
 
-- `master`: Production-ready code
-- `develop`: Integration branch for features
-- `feature/[feature-name]`: For new features
-- `bugfix/[bug-description]`: For bug fixes
-- `hotfix/[hotfix-description]`: For urgent production fixes
+## 💡 Why Open Source?
 
-### Pull Request Process
+At SolGuruz, we believe in giving back to the developer community.
+We’ve built apps for global clients using these internal practices and decided to share our foundation with YOU — the builders of tomorrow.
 
-1. Create a branch from `develop` for your task
-2. Make your changes and test thoroughly
-3. Push your branch and create a Merge Request to `develop`
-4. Ensure CI passes and request reviews
-5. Address review comments
-6. Request for review and merge the PR
+## ❤️ Credit & Attribution
 
-### Commit Guidelines
+If you use Skelter in your project, we’d love to hear about it!
+Give us a ⭐ on GitHub and mention [SolGuruz](https://solguruz.com) in your credits or README.
+It keeps us motivated to share more tools, kits, and open-source love.
 
-- Use clear, descriptive commit messages
-- Reference issue numbers in commits and PRs
-- Keep commits focused on single logical changes
+## License
 
-## How to Contribute
-
-1. Understand the project structure and coding standards
-2. Pick an issue from the issue tracker or create a new one
-3. Follow the Git workflow described above
-4. Ensure your code passes all tests
-5. Submit a Pull Request with a clear description of changes
-
-We appreciate your contributions to make this skelter project even better!
+This project is licensed under the MIT License - see the [MIT License](./LICENSE) file for details.