Skip to content

Latest commit

 

History

History
98 lines (64 loc) · 5.53 KB

CONTRIBUTING.md

File metadata and controls

98 lines (64 loc) · 5.53 KB
Raw

Contributing Guidelines 🤝

Thank you for considering contributing to PrivatePing! Contributions from individuals like you help improve and maintain the application's functionality and security.

To ensure a smooth and effective contribution process, please follow these guidelines:

How Can You Contribute?

There are several ways you can contribute to PrivatePing:

  • Bug Fixes: If you find any bugs or issues within the application, please report them by creating an issue in the GitHub repository. If you're able to fix the bug yourself, feel free to submit a pull request with the solution.

  • Feature Enhancements: Have an idea for a new feature or an improvement to an existing one? Let us know by creating an issue or directly implementing the feature and submitting a pull request.

  • Code Refactoring: Help improve the codebase by refactoring existing code to make it more efficient, readable, or maintainable.

  • Documentation: Contributions to documentation are highly valuable. If you find any gaps or inaccuracies in the documentation, or if you'd like to improve it, please do so and submit a pull request.

Getting Started

To start contributing to PrivatePing, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contributions.
  4. Make your changes, ensuring adherence to coding standards and guidelines.
  5. Test your changes thoroughly.
  6. Commit your changes with clear and descriptive commit messages.
  7. Push your changes to your forked repository.
  8. Submit a pull request to the main repository, detailing the changes you've made.

Need some help regarding the basics?

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the PrivatePing repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the PrivatePing repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the PrivatePing repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the PrivatePing repository.

Code Style

Please adhere to the existing code style and conventions used in the project. Consistent code style makes the codebase easier to read and maintain.

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please report them by creating an issue in the GitHub repository. Provide detailed information about the problem you encountered or the feature you'd like to see implemented.

Pull Request Process

  1. Ensure that you have self reviewed your code
  2. Make sure you have added the proper description for the functionality of the code
  3. Comment your code, particularly in hard-to-understand areas.
  4. Add screenshot for further help in review.
  5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon

License

By contributing to PrivatePing, you agree that your contributions will be licensed under the MIT License. Make sure to include appropriate license headers in new files you create or modify.

Thank you for your interest in contributing to PrivatePing! Your contributions are greatly appreciated.