Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

65 lines (46 loc) · 2.65 KB
Raw

Contributing to the Pheasant Framework

Thank you for considering contributing to The Pheasant Framework! We welcome contributions from the community to improve and enhance this Dart Web Framework.

Before you get started, please take a moment to review our contribution guidelines to ensure a smooth collaboration process.

Code of Conduct

This project and everyone participating in it are governed by our Code of Conduct. By participating, you agree to uphold this code. Please report any unacceptable behavior to this email.

How to Contribute

We welcome contributions in the form of bug reports, feature requests, code improvements, and documentation enhancements. To contribute, follow these steps:

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine. 
    git clone https://github.com/pheasantframework/pheasant.git
  3. Create a new branch for your changes. 
    git checkout -b feature/your-feature
  4. Make your changes and commit them with a clear and concise commit message. 
    git commit -am 'Add a new feature'
  5. Push your changes to your fork on GitHub. 
    git push origin feature/your-feature
  6. Open a pull request (PR) against the main branch of the original repository.

Code Guidelines

Please follow these guidelines when contributing to the project:

  • Adhere to the Dart style guide.
  • Write clear and concise code with comments where necessary.
  • Ensure that your code passes all existing tests.
  • Write new tests for new features or bug fixes.

Bug Reports

If you encounter a bug, please submit an issue on the issue tracker with the following information:

  • A clear and descriptive title.
  • A detailed description of the issue, including steps to reproduce.
  • The version of the package you are using.
  • Any relevant error messages or logs.
  • Any suggested solutions (if any).

Feature Requests

We welcome suggestions for new features, improvements and optimizations. Please submit a feature request on the issue tracker with the following information:

  • A clear and descriptive title.
  • A detailed description of the proposed feature.
  • Any additional context or examples that may be helpful.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing to The Pheasant Framework Template Package! Your efforts are greatly appreciated.