Thanks for your interest in contributing to fullstack-singer-platform 🎉 We welcome issues, feature requests, bug reports, and pull requests.
Please read and follow our CODE_OF_CONDUCT.md.
- 💬 Join the Discussions: Share your insights, provide feedback, or ask questions about Vevox.
- 🐛 Report Issues: Submit bugs found or log feature requests for the
fullstack-singer-platformproject. - 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.
This project welcomes community feedback and feature suggestions.
This repository serves as a community space to:
- Report bugs and unexpected behaviours in article server
- Request new features or improvements
- Propose integrations or ideas for extending Full Stack Singer Platform (for example: MCP-style adapters, plugins, or example integrations)
- Track the status of reported issues and feature requests
- Open the Bug Report form: Create a Bug Report
- Choose the appropriate template (Bug Report or Feature Request)
- Provide as much detail as possible:
- Steps to reproduce
- Expected behaviour
- Actual behaviour
- Relevant logs or screenshots
- System information (Node.js version, OS, browser)
- Open the Feature Request form: Create a Feature Request
- Use the Feature Request template
- Describe clearly:
- The feature you'd like to see
- Why it would be valuable for full stack singer platform users
- Any design/implementation ideas or trade-offs
- Open a new issue and use the available template
- Include:
- Name and short description of the integration
- Use cases and benefits
- Sample implementation or code snippets (optional)
- References to similar tools or standards
We use labels to indicate issue state. Common labels include:
triage— Under initial reviewaccepted— Approved for implementationin-progress— Work is currently being doneneeds-more-info— Additional information required from the reporter
Thanks for considering contributing to the Full Stack Singer Platfrom! Below is a short, friendly guide to make it easy for first-time contributors.
- Improve documentation or fix typos
- Suggest or add useful scripts, tools, or configurations (build scripts, example clients)
- Add UI/UX improvements to the chat frontend
- Report bugs or suggest new features
- Add sample integrations or adapters (e.g., connecting Article Platform to other platforms)
- Add tests or improve existing test coverage
- Fork the Repository: Start by forking the project repository to your github account.
- Clone Locally: Clone the forked repository to your local machine using a git client.
git clone https://github.com/MA1002643/fullstack-singer-platform
- Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x
- Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear message describing your updates.
git commit -m 'Implemented new feature x.' - Push to github: Push the changes to your forked repository.
git push origin new-feature-x
- Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
- Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
- Keep code readable and follow existing project style
- Add tests for new behaviour where possible
- Link any third-party resources you include
- Use meaningful commit messages and keep commits focused
- Be responsive to review feedback and update your PR when requested
- All contributions will be credited in the Contributors section.
- By contributing, you agree that your changes will be licensed under the project's MIT License.
- If you're unsure where to start, open an issue labelled
good-first-issueor ask in Discussions. - For direct questions about contributing workflows, open an issue and tag the maintainer.
© 2025 Muhammad Abdullah
Developed with 💙 using HTML, CSS, JavaScript
