Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 2.56 KB

Contributing to Fennix

We welcome contributions to Fennix! Whether you are reporting a bug, suggesting a feature, or submitting a pull request, we’re excited to collaborate with you.

Table of Contents

How to Contribute

  1. Check existing issues or discussions to see if your idea has already been mentioned or if someone is already working on it.
  2. If you’re new to the project, consider contributing to good first issues.
  3. Fork the repository and create a new branch for your changes.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Be respectful and inclusive while interacting with the community.

Getting Started

  1. Fork this repository and clone your fork.
  2. Set up your development environment according to the README.md or any other setup guide provided.
  3. Ensure all tests pass before submitting changes. Add tests for new features where applicable.

Pull Request Guidelines

  1. Keep pull requests focused on a single issue or feature.
  2. Write clear, descriptive commit messages.
  3. Ensure all tests pass before submitting your PR.
  4. Include a detailed description of your changes and reference any relevant issue numbers.
  5. Be open to feedback and revise your pull request if requested.
  6. Mark your pull request as a draft if it’s still a work in progress.

Reporting Issues

  1. Check if the issue has already been reported.
  2. Include a clear and descriptive title.
  3. Provide detailed steps to reproduce the problem (if applicable).
  4. Mention your environment details (e.g., OS, version, etc.).
  5. Attach screenshots or logs if they help explain the issue.

Style Guide

Follow the coding style used in the repository to ensure consistency. Adhere to:

  • Use CamelCase for all names.
  • Start function and global declaration names with an uppercase letter.
  • Start local variable names with a lowercase letter.
  • Maintain consistent formatting and commenting guidelines.

Refer to the style guide document if available.

Thank you for contributing! Your effort makes Fennix better for everyone. If you have any questions, feel free to reach out by opening an issue or joining our discussions.