Skip to content

README.md

Latest commit

 

History

History
71 lines (45 loc) · 2.49 KB

README.md

File metadata and controls

71 lines (45 loc) · 2.49 KB
Raw

Dozer Sample Contribution Guidelines

Thank you for your interest in contributing to the dozer-samples! This document outlines the guidelines and best practices to follow when submitting a community project. We appreciate your effort and look forward to collaborating with you.

Contribution Process

  1. Fork the dozer-samples repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch with a descriptive name related to your project (e.g., my-awesome-project).
  4. Add your project files to the community-samples directory within the repository.
  5. Commit your changes and push them to your forked repository.
  6. Submit a Pull Request (PR) from your forked repository to the main dozer-samples repository.

Project Structure

Please structure your project as follows:

community-samples/
    ├── your-project-name/
    │   ├── your-project-file_1/
    │   ├── your-project-file_n/
    │   ├── README.md
    │   └── LICENSE
    └── ...
  • README.md: A Markdown file providing a detailed description of your project, installation instructions, usage, and any other necessary information.
  • LICENSE: A text file specifying the license under which your project is distributed.

Pull Request (PR) Template

When submitting a PR, please include the following information:

### Project Name

*Short description of your project*

### Project Description

*Provide a more detailed description of your project, its purpose, and how it works*
*You can also add architecture diagram if you have any*

### Features

- List of key features or highlights of your project
- Add as many bullet points as needed

### Installation & Usage

*Provide detailed instructions for installation and usage of your project*

### License

*Specify the license under which your project is distributed*

### Checklist

- [ ] I have read the contribution guidelines
- [ ] I have provided a README.md with detailed information about my project
- [ ] I have provided all necessary assets (if applicable)
- [ ] I have included the LICENSE file in my project

By following these guidelines and using the provided PR template, you'll have a smooth review process and timely integration of your project into the dozer-samples repository.

Thank you for your contribution! 🤗 🙏