Skip to content

contributing.md

Latest commit

 

History

History
103 lines (62 loc) · 2.71 KB

contributing.md

File metadata and controls

103 lines (62 loc) · 2.71 KB
Raw

Contributing to PowerRTI

Thank you for considering contributing to PowerRTI! We appreciate your interest in helping improve and grow this project. This guide will help you get started.

How You Can Contribute

There are many ways to contribute to this repository:

  1. Report Bugs

    • Found a bug? Let us know by creating an issue.
    • Include clear steps to reproduce the problem and details like environment and version.

  2. Propose New Features

    • Have an idea for a new feature? Open an issue to discuss it.
    • Describe the feature, its benefits, and any possible implementation ideas.

  3. Fix Bugs or Implement Features

    • Check the Issues tab for tasks.
    • Look for issues labeled with good first issue or help wanted.

  4. Improve Documentation

    • Help update or enhance the documentation.
    • Fix typos, clarify concepts, or write new guides.

  5. Suggest Enhancements

    • Share suggestions to make the project better.

  6. Test Changes

    • Help test new features or bug fixes before they are released.

Getting Started

  1. Fork the Repository

    • Click the "Fork" button on the top right of this repository to create your own copy.

  2. Clone Your Fork

    git clone https://github.com/your-username/[repository-name].git
cd [repository-name]

  3. Set Up the Environment

    • Follow the instructions in the README.md to set up the project on your local machine.

  4. Create a Branch

    • Always create a new branch for your work:

      git checkout -b feature/your-feature-name

  5. Make Your Changes

    • Write clear and concise code.
    • Follow the project's coding style and conventions.

  6. Test Your Changes

    • Run tests to ensure your changes don't break anything:

  7. Commit Your Changes

    • Write descriptive commit messages:

      git add .
git commit -m "Add feature: [your-feature-name]"

  8. Push to Your Fork

    git push origin feature/your-feature-name

  9. Create a Pull Request (PR)

    • Go to the original repository and click "New Pull Request."
    • Follow the template, and provide details about your changes.

Code of Conduct

This project follows a Code of Conduct to ensure a welcoming and inclusive environment. Please review it before contributing.

Community Guidelines

  • Be respectful and considerate.
  • Provide constructive feedback.
  • Collaborate openly and support others.

Need Help?

If you have any questions or need assistance, feel free to open an issue or reach out to us.

Thank you for contributing to PowerRTI! Together, we can make this project better!