Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
108 lines (70 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

108 lines (70 loc) · 2.52 KB
Raw

Contributing to Mahvex

Thank you for your interest in contributing to Mahvex.

Mahvex is continuously evolving, and constructive feedback, documentation improvements, ideas, and community contributions can help improve the platform.

1. What You Can Contribute

This repository is primarily intended for public information and documentation related to Mahvex.

You can contribute by:

  • Improving documentation.
  • Fixing spelling, grammar, or factual errors.
  • Suggesting improvements to public documentation.
  • Reporting broken links.
  • Reporting incorrect or outdated information.
  • Suggesting new documentation.
  • Sharing constructive ideas about the Mahvex ecosystem.
  • Reporting issues with publicly documented services.

2. Before Contributing

Before opening an issue or pull request, please:

  • Search existing issues and pull requests.
  • Make sure your contribution is relevant.
  • Read the Community Guidelines.
  • Do not include private, confidential, or sensitive information.

3. Pull Requests

When submitting a pull request:

  1. Clearly describe what you changed.
  2. Explain why the change is needed.
  3. Keep changes focused and relevant.
  4. Check that links and Markdown formatting work correctly.
  5. Avoid unrelated changes.

4. Documentation Contributions

Documentation contributions should be:

  • Clear
  • Accurate
  • Concise
  • Easy to understand
  • Consistent with the Mahvex brand and terminology

Do not add information about unreleased features as if they were already available.

5. Reporting Problems

If you find an error in the documentation or public information, you can open a GitHub Issue.

For security vulnerabilities, do not create a public issue.

Instead, follow the instructions in:

Security Policy

6. Respect Privacy

Do not submit:

  • Passwords
  • API keys
  • Authentication tokens
  • Private user information
  • Confidential business information
  • Private communications

If you accidentally expose sensitive information, report it to the Mahvex team immediately.

7. Review Process

Contributions may be reviewed by Mahvex maintainers before being merged.

A contribution may be modified, rejected, or requested for changes if it does not meet the project's requirements.

8. Code of Conduct

All contributors are expected to follow the:

Mahvex Community Guidelines

9. Contact

For general questions:

Email: mahvex.official@gmail.com

For security issues:

See Security Policy.

Mahvex — Everything for Developers