Contributing to xyOps

Guidelines for contributing to xyOps through bug fixes, plugins, documentation, and community support

We love open source, and we’re thrilled that you want to help make xyOps even better! This document explains how to work effectively with the xyOps team and where your efforts can have the biggest impact.

Before You Open a Pull Request

We are not currently accepting feature pull requests (PRs), except under special circumstances.

If you have a great idea for a new feature, please:

1. Open a GitHub Issue

   Create a new issue to describe your idea.

2. Describe Clearly

   Use clear and concise language, including use cases and benefits.

3. Gather Support

   Encourage others to give your issue a 👍 reaction.

4. Wait for Approval

   Wait for a Dev team member to approve the idea before writing any code.

We generally prefer to design and implement new features in-house, but we’re very responsive and regularly integrate popular feature requests quickly. Your feedback shapes the roadmap!

Accepted Contributions

There are plenty of valuable ways to contribute:

Bug Fixes

Small, well-scoped fixes are welcome!

Requirements:

Code Quality

• Your PR should clearly describe the issue and the reasoning behind your change
• All unit tests must pass (npm test)
• Follow our code style (see the Development Guide)
• Commits must be signed off (DCO) and GPG-signed

Testing

• Add tests for your fix if applicable
• Run the full test suite before submitting
• Ensure no regressions are introduced

Security Issues

Please do not open GitHub issues for security vulnerabilities.

Instead, follow the responsible disclosure process described in our Security Guide.

Contact Methods:

• GitHub Security Advisories
• Email: [e-mail]

Localization

We’re preparing a formal localization process! If you speak languages other than English, we’d love your help translating xyOps once this is ready.

Watch for updates in the GitHub Issues area.

Plugin Development

Our biggest need right now is Plugins! xyOps is built around an open plugin architecture, and we would love your contributions here.

How to Contribute Plugins:

1. Read the Plugin Guide

   See the Plugin Guide for full development and publishing details.

2. Publish on GitHub

   Host your plugin on GitHub with clear documentation.

3. Register on Marketplace

   Submit your plugin to the xyOps Plugin Marketplace.

4. Use OSI-Approved License

   Plugins should use an OSI-approved license and include clear documentation of any security considerations.

Documentation Improvements

We happily accept PRs that improve our docs!

Guidelines:

Writing Style

• All documentation lives in /docs
• Follow the writing style in the Development Guide
• Use clear, concise language
• Include practical examples where appropriate

Images & Diagrams

• Screenshots/diagrams should be PNG or WebP (lossless)
• Include proper alt-text for accessibility
• Keep file sizes reasonable

Spread the Word

If you enjoy xyOps, help us grow the community:

Social Media

• Mention xyOps on Bluesky and Mastodon
• Boost our posts!
• Share your xyOps success stories

Community Support

• Participate in GitHub Discussions
• Help out new users with their questions
• Share your workflows and recipes

Video Content

• Subscribe to our YouTube Channel
• Leave likes on videos you enjoy
• Share tutorials with your team

Development Guidelines

Technical Stack

Component	Technology
Runtime	Node.js LTS
Language	Plain JavaScript (no frameworks)
Testing	pixl-unit
License	BSD-3-Clause

Setup

For code style and setup details, see the Development Guide.

Quick Start:

git clone https://github.com/pixlcore/xyops.git
cd xyops
npm install
node bin/build.js dev
bin/debug.sh

Code Style

JavaScript Conventions

• Use tabs for indentation
• Follow existing naming conventions
• Add comments for complex logic
• Keep functions focused and small

Commit Messages

• Use clear, descriptive commit messages
• Reference issue numbers when applicable
• Sign commits with DCO (Developer Certificate of Origin)
• GPG-sign all commits

Pull Request Process

1. Fork and Clone

   Fork the repository and clone your fork locally.

2. Create Branch

   Create a branch for your changes:

   git checkout -b fix/issue-description
   
3. Make Changes

   Implement your fix or improvement.

4. Test Thoroughly

   Run all tests and verify your changes:

   npm test
   
5. Commit with DCO

   Sign off your commits:

   git commit -s -m "Fix: Description of fix"
   
6. Push and Create PR

   Push to your fork and create a pull request with a clear description.

Code of Conduct

All participants are expected to follow our Code of Conduct.

Core Principles:

• Be respectful and inclusive
• Welcome newcomers and help them learn
• Focus on constructive feedback
• Assume good intentions
• Foster a welcoming community

By contributing to xyOps, you agree to foster a welcoming, respectful community.

Contribution Ideas

Not sure where to start? Here are some ideas:

Good First Issues

• Look for issues tagged “good first issue” on GitHub
• Fix typos or improve documentation clarity
• Add examples to existing docs
• Write tutorials or how-to guides

Plugin Ideas

• Integration with popular services (Slack, Discord, etc.)
• Cloud provider integrations (AWS, Azure, GCP)
• Monitoring and alerting plugins
• Custom trigger plugins for specific use cases

Documentation Needs

• More practical examples and recipes
• Video tutorials and screencasts
• Architecture diagrams
• Translation to other languages

Getting Help

Need help with your contribution?

Community Support

• Ask in GitHub Discussions
• Check existing issues for similar questions
• Join our community channels

Technical Questions

• Review the Development Guide
• Check the API documentation
• Look at existing code for examples

Recognition

We value all contributions, big and small:

• Bug fixes: Mentioned in release notes
• Plugins: Featured in the Marketplace
• Documentation: Credited in commit history
• Security reports: Credited in security advisories (if desired)

Thank You

Your time and effort mean a lot to us. Even if you’re not writing code, every issue, translation, plugin, or mention helps make xyOps better for everyone.

Together, we can make xyOps truly awesome.

— The PixlCore Team