Skip to content

Contributing

Jump to bottom
Alexander Hamilton edited this page Dec 4, 2024 · 1 revision

We welcome contributions to enhance the Principles Framework! Whether you're a developer looking to add new features, a researcher interested in improving methodologies, or a user with feedback, your contributions are invaluable in shaping the future of Principles.

How to Contribute

1. Fork the Repository

Start by forking the Principles repository on GitHub to your own account.

git clone https://github.com/miltonian/principles.git
cd principles

2. Create a New Branch

Create a new branch for your feature or bug fix to keep your work organized and isolated from the main codebase.

git checkout -b feature/your-feature-name

3. Make Your Changes

Implement your feature or fix the bug. Ensure that your changes align with the framework's architecture and standards.

4. Commit Your Changes

Commit your changes with a clear and descriptive message explaining what you've done.

git commit -m "Add feature: Your feature description"

5. Push to Your Fork

Push your changes to your forked repository on GitHub.

git push origin feature/your-feature-name

6. Submit a Pull Request

Navigate to the original Principles repository on GitHub and create a pull request from your forked repository. Provide a detailed description of your changes and why they are beneficial.

Code Standards

Please ensure that your code follows the project's coding standards and includes appropriate tests. Consistency and quality are crucial for maintaining the integrity of the framework.

  • Linting: Use the existing linting configurations to maintain code quality.
  • Documentation: Document your code thoroughly to aid understanding and future development.
  • Testing: Write tests for new features or bug fixes to ensure they work as intended and do not introduce regressions.

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please open an issue in the repository. Provide as much detail as possible to help us understand and address the problem.

  • Bug Reports: Include steps to reproduce the issue, expected behavior, and actual behavior.
  • Feature Requests: Clearly describe the feature, its benefits, and how it would integrate with the existing framework.

Guidelines for Contributors

  • Be Respectful: Maintain a respectful and collaborative tone in all interactions.
  • Be Clear and Concise: Provide clear and concise descriptions in your commits, pull requests, and issue reports.
  • Be Open to Feedback: Be prepared to receive and incorporate feedback to improve your contributions.

Getting Started

If you're new to contributing, consider starting with the following:

  • Explore Open Issues: Look for issues labeled as "good first issue" or "help wanted" to begin.
  • Review Documentation: Familiarize yourself with the framework's documentation and architecture.
  • Engage with the Community: Join discussions, ask questions, and seek guidance from other contributors.

Acknowledgments

Thank you for your interest in contributing to the Principles Framework! Your efforts help us build a more robust, efficient, and effective tool for generating specialized AI agents.

Clone this wiki locally