Skip to content

Latest commit

 

History

History
122 lines (85 loc) · 4.54 KB

Contributor.md

File metadata and controls

122 lines (85 loc) · 4.54 KB

Contributor Guide for Zeppelinbot-Setup-Guide

Welcome to the heyjumanji/Zeppelinbot-Setup-Guide repository! We appreciate your interest in contributing. This guide outlines how to contribute effectively to this project.

Table of Contents

  1. Getting Started
  2. Code of Conduct
  3. How to Contribute
  4. Development Guidelines
  5. Testing Your Changes
  6. Documentation
  7. License

Getting Started

  1. Fork the Repository: Click the "Fork" button on the top right to create your own copy of the repository.
  2. Clone Your Fork: Use the command below to clone your fork to your local machine: 
    git clone https://github.com/your-username/repository-name.git
  3. Set Upstream Remote: To keep your fork up-to-date with the original repository: 
    git remote add upstream https://github.com/original-owner/repository-name.git

Code of Conduct

We are committed to creating a welcoming environment for all contributors. By participating in this project, you agree to abide by the following:

Our Pledge

We pledge to make participation in this project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing opinions and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others’ private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [your contact email]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.

How to Contribute

Reporting Issues

If you encounter a bug or have a feature request, please open an issue in the repository:

  1. Go to the "Issues" tab.
  2. Click "New Issue."
  3. Provide a clear and descriptive title and fill out the issue template.

Suggesting Enhancements

We welcome suggestions! If you have an idea that could improve the project:

  1. Open a new issue.
  2. Use the enhancement template to describe your suggestion in detail.

Submitting Code

If you want to contribute code:

  1. Create a New Branch: 
    git checkout -b feature/your-feature-name
  2. Make Changes: Implement your changes.
  3. Commit Your Changes: Write clear and descriptive commit messages. 
    git commit -m "Add feature: your-feature-name"
  4. Push to Your Fork: 
    git push origin feature/your-feature-name
  5. Create a Pull Request: Go to the original repository, click on "Pull Requests," and then "New Pull Request." Choose your branch and submit.

Development Guidelines

  • Follow existing coding style and conventions.
  • Keep your commits focused and organized.
  • Write comments and documentation where necessary.

Testing Your Changes

Ensure that your changes do not break existing functionality:

  1. Run the existing test suite using: 
    npm test  # or your relevant command
  2. Add tests for any new functionality you implement.

Documentation

Update any relevant documentation to reflect your changes. Documentation should be clear and concise.

License

This project is licensed under the MIT License. Please make sure to review it before contributing.

Thank you for your interest in contributing to this project! We look forward to your contributions. If you have any questions, feel free to reach out via issues or discussions.