Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (42 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

49 lines (42 loc) · 1.65 KB

Contributing to ZeroSMTP

Thank you for your interest in contributing to ZeroSMTP! Below you will find sections on how to report bugs, suggest features, set up your development environment, submit pull requests, and adhere to code style guidelines.

Bug Reporting

  • Please check the existing issues to see if your bug has already been reported.
  • If not, create a new issue with a clear title and description of the problem. Include steps to reproduce, expected behavior, and actual behavior.

Feature Suggestions

  • We welcome suggestions for new features! Please create a new issue for any feature you would like to propose.
  • Describe the feature and its benefits for users.

Development Setup

  1. Clone the repository: 
    git clone https://github.com/msgwing/ZeroSMTP.git
cd ZeroSMTP
  2. Install the required dependencies (if applicable): 
    # Installation commands here
  3. Run the application to ensure everything is working: 
    # Run command here

Pull Request Process

  • Fork the repository and clone it to your local machine.
  • Create a new branch for your feature or bug fix: 
    git checkout -b my-feature-branch
  • Make your changes and commit them: 
    git commit -m "Add some feature"
  • Push to your fork and submit a pull request: 
    git push origin my-feature-branch

Code Style Guidelines

  • Please follow the existing code style in the project.
  • Use meaningful names for variables and functions.
  • Maintain consistent indentation and spacing.
  • Write comments where necessary for clarity.

Thank you for contributing! We appreciate your help in improving ZeroSMTP!