Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (30 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.65 KB

Contributing to FnAPI

Thank you for your interest in contributing to the FnAPI project! We appreciate all forms of contributions, including bug reports, feature requests, and code improvements. Please follow the guidelines below to help us manage contributions effectively.

How to Contribute

Reporting Bugs

  1. Search the Issue Tracker: Before reporting a new bug, please search the issue tracker to see if the bug has already been reported.
  2. Create a New Issue: If the bug hasn't been reported yet, create a new issue with a clear description of the problem. Please include:
    • Steps to reproduce the bug.
    • The expected behavior and what actually happened.
    • Any relevant error messages or logs.

Requesting Features

  1. Check Existing Requests: Review the issue tracker to see if the feature has already been requested.
  2. Submit a Feature Request: If your feature idea hasn't been proposed yet, create a new issue with the following details:
    • A clear and concise description of the feature.
    • The problem or need that the feature addresses.
    • Any relevant use cases or examples.

Contributing Code

  1. Fork the Repository: Fork the repository on GitHub and clone your fork locally.
  2. Create a Branch: Create a new branch for your changes. Use a descriptive name for the branch (e.g., fix-issue-123, add-feature-xyz).
  3. Make Changes: Implement your changes and make sure to write clear, concise commit messages.
  4. Test Your Changes: Run tests to ensure your changes work as expected and do not introduce new issues.
  5. Submit a Pull Request: Push your changes to your fork and submit a pull request to the main branch of the original repository. Provide a clear description of your changes and reference any related issues.

Code Style and Best Practices

  • Follow Existing Code Style: Ensure your code follows the existing style and conventions used in the project.
  • Write Tests: Include tests for any new functionality or bug fixes you implement.
  • Documentation: Update documentation to reflect any changes or new features.

Code of Conduct

We expect everyone to follow our Code of Conduct to ensure a welcoming and respectful environment for all contributors.

Contact

If you have any questions or need assistance, please reach out to us through the issue tracker or contact us directly at phongtrong865@gmail.com.

Thank you for contributing to FnAPI!