Thank you for your interest in contributing to ngXpress! Your help is greatly appreciated. Please follow these guidelines to make the process smooth for everyone.
- Search existing issues before opening a new one.
- Provide a clear, descriptive title and as much relevant information as possible (steps to reproduce, expected vs. actual behavior, screenshots, etc.).
- Check if your idea already exists in issues.
- Clearly describe the feature, its use case, and any alternatives you’ve considered.
- Fork the repository and create your branch from
main. - Describe your changes in the pull request (PR) template.
- Keep PRs focused: One feature or fix per PR is best.
- Write clear, concise commit messages.
- Add tests for new features or bug fixes when possible.
- Follow the coding style (see below).
- Ensure your code builds and passes linting/tests before submitting.
- Use Prettier and ESLint for code formatting and linting.
- Use TypeScript for all code (frontend and backend).
- Organize code by feature (feature-first structure).
- Use import aliases instead of long relative paths.
- Write clear, descriptive comments where necessary.
- Frontend:
src/app/(Angular) - Backend/API:
src/api/(Express) - Database:
prisma/(Prisma schema)
- Use clear, descriptive commit messages (e.g.,
fix(auth): handle token expiration,feat(todos): add bulk delete endpoint). - Reference issues by number when relevant (e.g.,
fix: resolve #42).
Please be respectful and inclusive. See CODE_OF_CONDUCT.md if available.
- For questions, open a discussion or issue.
- You can also reach out to @immohammadjaved on X (Twitter).
Thank you for helping make ngXpress better! 🎉