Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (29 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

48 lines (29 loc) · 2.86 KB
Raw

Contributing to fxManager

Thank you for considering contributing to fxManager ! This is planned to be a community driven project with as main goal to challenge myself (Maximus7474) to create a system that can be easily joined by other developers in an objective of creating something that will last.

🚀 Where to Start?

Before you start writing code, check if the work is already planned or in progress:

  1. In-Code Tasks: Search the codebase for the string ToDo (case-sensitive). These are specific technical improvements identified by the maintainers.
  2. Active Issues: Browse the Issues tab to see what is currently being discussed.

💬 Communication & Discussion

We value open dialogue. There are two primary ways to discuss the technical direction of the project:

  • In-File Discussions: If you have questions about a specific block of code or notice a potential bug while reading a file, feel free to start a discussion in a Pull Request or reference the file/line in a new Issue. We welcome "sanity checks" and technical critiques on our existing implementation.
  • Proposing New Ideas: If you want to add a feature or perform a refactor not listed in the roadmap or ToDo comments, please open an Issue first.
  • Draft PRs: If your proposal requires a code demonstration, open a Draft PR. This signals that the work is a "proof of concept" and not yet ready for a final merge.

🛡️ Security Policy

Do not report security vulnerabilities through public issues.

If you discover a security-related bug or vulnerability, please use the GitHub Security Advisory system to report it privately. This allows maintainers to fix the issue and coordinate a disclosure without exposing users to unnecessary risk.

⚖️ Legal & Licensing

To maintain the integrity of the project, please adhere to these legal standards:

  • License Compliance: Only contribute code, assets, or documentation that you have the legal right to share. All contributions must be compatible with the project's license.
  • Attribution: If your work is derived from another open-source project, you must attribute credit in the relevant files or documentation, adhering to the original author's license requirements.
  • No Plagiarism: Do not copy-paste code from proprietary or "all rights reserved" sources.

🛠️ Pull Request Process

  1. Fork the repo and create your branch from main.
  2. Lint/Format your code to match the existing style.
  3. Update documentation if you are changing how a feature works.
  4. Link your PR to the relevant issue (e.g., Closes #123).
  5. Be Patient: Maintainers will review your PR as soon as possible.