Contributing
Contributing
PalmTechnIQ is a private project developed by ISCE Digital Concept, and contributions are currently limited to internal team members and invited collaborators. This section provides guidance for those involved in enhancing the platform, ensuring a collaborative and efficient development process.
If you’re part of the team or an authorized contributor, follow the steps below to participate in the platform’s development. For external inquiries or future collaboration opportunities, please contact us.
Getting Involved
To contribute, set up the project locally by following the Installation instructions (available once completed). Once set up, proceed with the workflow outlined below.
- Request Access: Contact the project lead (e.g., via admin@palmtechniq.com) to gain repository access or discuss your contribution.
- Create a Branch: Use a descriptive branch name (e.g.,
feature/new-module
) for your changes. - Submit Changes: Push your changes to the repository and notify the team via GitHub Issues or your preferred communication tool (e.g., Slack, email).
Coding Standards
Maintain consistency with the following standards:
- Code Style: Adhere to TypeScript and React conventions, using Prettier and ESLint as configured.
- Commit Messages: Use clear messages (e.g.,
feat: add new feature
) for tracking purposes. - Testing: Add or update tests as needed, ensuring compatibility with existing tests.
Review and Approval
All changes will be reviewed by the project lead or designated team members. Provide a summary of your work when submitting, and address feedback promptly. Approved changes will be merged into the main branch.
Support and Communication
For questions, feature requests, or issues, reach out to the team at support@palmtechniq.com or use our internal communication channels. Stay updated via the Changelog.
We appreciate your efforts in advancing PalmTechnIQ’s mission, and we look forward to your contributions!