Contributing

❤️ First off, thank you for considering contributing to Reducord! It's people like you who make open-source tools better for everyone. Below is a set of guidelines to help you get started.

🚩 How Can I Contribute?

1. Reporting Bugs

• Check the Issues tab to see if the bug has already been reported.
• If not, open a new issue. Include your Windows version, Discord version, and steps to reproduce the bug.
• Attach a screenshot of the Reducord log if possible.

2. Suggesting Enhancements

• We are always open to new ideas! Open an issue with the tag enhancement.
• Describe the feature, why it’s needed, and how it should look in the UI.

3. Pull Requests

• Branching: Always create a new branch from dev (e.g., feature/your-feature-name or fix/bug-name).
• Conventional Commits: Use the format type(scope): message (e.g., feat(ui): add progress bar).
• Code Style: Keep the code consistent with the existing codebase (K&R or Allman style, just be consistent).

🛠 Development Workflow

1. Fork the repository and clone it locally.
2. Create a feature branch from the dev branch.
3. Implement your changes.
4. Ensure the project builds successfully in Release x64 mode.
5. Submit a Pull Request to our dev branch (not main!).

📜 Coding Standards

To maintain a clean and readable codebase, we follow these simple rules:

• UI: Use Dear ImGui built-in functions for styling. Avoid hardcoding pixel offsets where possible.
• Safety: Always check if a file/directory exists before attempting deletion.
• Localization: For now, the primary language for the UI and logs is English.
• Modern C++: We use C++17 features. Avoid using deprecated Win32 calls if a modern alternative exists.

💬 Communication

If you have questions or want to discuss a major architectural change, feel free to go to Discussions.

---

Back to Home