Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
100 lines (69 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

100 lines (69 loc) · 2.91 KB
Raw

Contributing to OpenAI Agent Builder GUI

Thank you for considering contributing to the OpenAI Agent Builder GUI! This document provides guidelines and instructions for contributing to this project.

IMPORTANT: This project is created by J. Gravelle (https://j.gravelle.us | j@gravelle.us) and is not affiliated with, endorsed by, or sponsored by OpenAI. It is an independent tool designed to work with the OpenAI Agents SDK.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please be respectful, inclusive, and considerate in all interactions.

How Can I Contribute?

Reporting Bugs

If you find a bug, please create an issue with the following information:

  • A clear, descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots (if applicable)
  • Environment details (browser, OS, etc.)

Suggesting Enhancements

We welcome suggestions for enhancements! Please create an issue with:

  • A clear, descriptive title
  • A detailed description of the proposed enhancement
  • Any relevant examples, mockups, or references
  • Why this enhancement would be useful to most users

Pull Requests

  1. Fork the repository
  2. Create a new branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests to ensure your changes don't break existing functionality
  5. Commit your changes (git commit -m 'Add some amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

  1. Clone the repository
git clone https://github.com/yourusername/openai-agent-builder.git
cd openai-agent-builder
  1. Install dependencies
npm install
  1. Start the development server
npm start

Coding Guidelines

JavaScript/React

  • Follow the existing code style
  • Use functional components with hooks
  • Add comments for complex logic
  • Keep components small and focused on a single responsibility
  • Use meaningful variable and function names

CSS/Styling

  • Use Material UI components and styling system
  • Maintain consistent spacing and sizing
  • Ensure responsive design works on various screen sizes

Testing

  • Write tests for new features
  • Ensure all tests pass before submitting a PR
  • Test on different browsers if making UI changes

Documentation

  • Update the README.md if you change functionality
  • Document new features, props, and components
  • Include JSDoc comments for functions and components

Review Process

All submissions require review. We use GitHub pull requests for this purpose.

  1. A maintainer will review your PR
  2. They may ask for changes or improvements
  3. Once approved, your PR will be merged
  4. Your contribution will be acknowledged in the project

Thank You!

Your contributions are what make the open-source community such an amazing place to learn, inspire, and create. We appreciate your efforts to improve this project!