mirror of
https://github.com/NicolasBohn/NexQuant.git
synced 2026-07-28 07:57:44 +00:00
11b347d0e7
- Rebrand from RD-Agent to Predix for EUR/USD quantitative trading - Update all documentation to English - Remove Microsoft-specific references - Clean up temporary files and backups - Update LICENSE, README, and configuration for PredixAI organization Breaking changes: - Project name changed from 'rdagent' to 'predix' in pyproject.toml - All Microsoft and RD-Agent branding replaced with Predix - Documentation completely rewritten for EUR/USD focus Documentation: - README.md: Professional English documentation with installation, quick start, CLI reference - CHANGELOG.md: Cleaned up, references upstream RD-Agent for historical changes - CODE_OF_CONDUCT.md: Switched to Contributor Covenant v2.0 - SECURITY.md: Predix-specific vulnerability reporting process - SUPPORT.md: Updated support channels (nico@predix.io, GitHub Discussions) - CONTRIBUTING.md: Adapted for Predix project - docs/: Sphinx configuration updated for Predix branding Configuration: - pyproject.toml: Updated project metadata, keywords, URLs for PredixAI - .gitignore: Comprehensive Python/gitignore template - Makefile: Updated CI pages URL - setup_predix_eurusd.sh: Translated to English Cleanup: - Deleted log files, caches, __pycache__ directories - Removed backup files (*.backup_*) - Cleaned web/node_modules
1.7 KiB
1.7 KiB
Contributing to Predix
We welcome contributions and suggestions to improve Predix. Whether it's solving an issue, addressing a bug, enhancing documentation, or even correcting a typo, every contribution is valuable and helps improve the project.
Getting Started
To get started, you can explore the issues list or search for TODO: comments in the codebase by running:
grep -r "TODO:"
How to Contribute
- Fork the Repository: Create a fork of the repository on GitHub.
- Clone the Repository: Clone your forked repository to your local machine.
git clone https://github.com/your-username/predix.git - Create a Branch: Create a new branch for your changes.
git checkout -b feature/your-feature-name - Make Changes: Make your changes to the codebase.
- Commit Changes: Commit your changes with a descriptive commit message.
git commit -m "Description of your changes" - Push Changes: Push your changes to your forked repository.
git push origin feature/your-feature-name - Ensure CI Passes: Make sure your code passes the automatic CI checks on GitHub.
- Create a Pull Request: Create a pull request from your forked repository to the main repository.
Code of Conduct
Please adhere to the Code of Conduct in all your interactions with the project.
Reporting Issues
If you encounter any issues or have suggestions for improvements, please open an issue on GitHub.
Guidelines
- Ensure your code follows the project's coding standards.
- Write clear and concise commit messages.
- Update documentation as needed.
- Test your changes thoroughly before submitting a pull request.
Thank you for contributing to Predix!