Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

57 lines (44 loc) · 2.17 KB

Contributing to PingRoute

First off, thank you for considering contributing to this project! Your contributions are valuable and help improve the project.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on the GitHub repository. Include the following details:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected and actual results.
  • Screenshots, if applicable.

Suggesting Enhancements

If you have ideas for new features or improvements, please submit them as issues. Provide as much detail as possible, including:

  • A clear and descriptive title.
  • Detailed description of the enhancement.
  • Rationale for why the enhancement would be beneficial.
  • Any potential challenges or considerations.

Code Contributions

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page.

  2. Clone Your Fork:

    git clone https://github.com/HarmanPreet-Singh-XYT/SysResource.git

  3. Create a Branch:

    git checkout -b feature/your-feature-name
or
git checkout -b bugfix/your-bugfix-name

  4. Make Changes: Implement your changes in the codebase.:

    git clone https://github.com/HarmanPreet-Singh-XYT/SysResource.git

  5. Commit Changes:

    git commit -m "Description of the changes you made"

  6. Push to Your Fork:

    git push origin your-branch-name

  7. Open a Pull Request: Go to the original repository and open a pull request. Provide a clear description of your changes and the motivation behind them.

Code Style

  • Please adhere to the existing code style and conventions used in the project. This ensures consistency and readability across the codebase.

Documentation

  • If you make any changes that affect the usage or functionality of the project, update the documentation accordingly. This includes the README, code comments, and any other relevant documentation files.

Thank You!

  • Thank you for taking the time to contribute to this project. Your efforts are greatly appreciated!

Contact

  • For any questions or further discussion, feel free to reach out via email at [email protected].