Skip to content

Latest commit

 

History

History
38 lines (32 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

38 lines (32 loc) · 2.16 KB
Raw

Contributing to Postbot

Thank you for considering contributing to Postbot! Before you begin, please take a moment to review the following guidelines:

Code of Conduct

This project adheres to the Postman Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@postman.com.

How to Contribute

There are several ways to contribute to Postbot:

  • Report bugs: If you find a bug in Postbot, please open a new issue on GitHub and include as much detail as possible.
  • Submit feature requests: If you have an idea for a new feature in Postbot, please open a new issue on GitHub and describe your suggestion.
  • Contribute code: If you would like to contribute code to Postbot, please follow the steps below.

Steps to Contribute Code

  • Fork the repository on GitHub.
  • Create a new branch for your changes.
  • Make your changes and commit them to your branch.
  • Test your changes thoroughly.
  • Submit a pull request to the main repository and describe your changes in detail.

Code Guidelines

To maintain consistency and readability in the Postbot codebase, please adhere to the following guidelines when contributing code:

  • Follow the PEP 8 style guide for Python code.
  • Use clear and descriptive variable and function names.
  • Write concise, modular code that can be easily understood and maintained.
  • Use comments sparingly to explain complex code or functionality.
  • Include docstrings for all classes, functions, and modules.

Commit Guidelines

To keep the Postbot commit history organized and easy to understand, please follow these guidelines when making commits:

  • Write clear and descriptive commit messages that summarize the changes you have made.
  • Use the present tense when writing commit messages.
  • Use imperative mood when writing commit messages.
  • Limit each commit to a single logical change.
  • Use small, incremental commits rather than large, sweeping changes.

License

By contributing to Postbot, you agree that your contributions will be licensed under the MIT License. See the LICENSE file (https://github.com/fagun18/postbot/blob/main/LICENSE) for more information.

Thank you for your contributions to Postbot!