Contribution
Contributing to Novus CMS
Thank you for your interest in contributing to Novus CMS! This document provides a simple set of guidelines for contributing to the project.
How to Contribute
- Fork the repository
- Create a feature branch:
git checkout -b feature/your-feature-name
- Commit your changes:
git commit -m 'Add some feature'
- Push to your branch:
git push origin feature/your-feature-name
- Submit a pull request
Development Setup
# Clone your fork
git clone https://github.com/YOUR_USERNAME/novus.git
# Install dependencies
composer install
npm install
# Set up for development
php artisan novus:dev
# Run tests
composer test
npm run test
Code Style
- PHP code should follow PSR-12 coding standards
- JavaScript/TypeScript code should follow the project's ESLint configuration
- Run code style checks before submitting a PR:
Testing
- All new features should include appropriate tests
- Ensure all tests pass before submitting a PR
- Run tests with:
composer test npm run test
Pull Request Guidelines
- Keep PRs focused on a single feature or bug fix
- Include a clear description of the changes
- Reference any related issues
- Update documentation if necessary
Questions?
If you have questions about contributing, feel free to open an issue with your question.
Thank you for helping improve Novus CMS!