Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 2.05 KB

Contributing to SocialPredict

We welcome contributions from the community and are pleased that you're interested in participating in the development of SocialPredict. Here are the guidelines we'd like you to follow:

How to Contribute

  1. Fork the Repository

    • Start by forking the SocialPredict repository to your GitHub account.
  2. Clone Your Fork

    • Clone your fork to your local machine to start making changes.
  3. Create a Branch

    • Create a new branch in your local repository before starting your work.
    • Use a clear branch name that describes the intent of your work, such as feature/add-login or fix/header-bug.
    • Make sure your branch name starts with feature, fix, refactor or doc followed by a / and description.
  4. Commit Your Changes

    • Keep your commits as atomic as possible, each addressing a single concern.
    • Use clear and descriptive commit messages.
  5. Push Your Changes

    • Push your changes to your fork on GitHub.
  6. Submit a Pull Request

    • Open a pull request to the main SocialPredict repository.
    • Provide a concise description of the changes and the reasoning behind them.

Reporting Issues

If you find a bug or have a feature request, please use the GitHub Issues tab to report them. Before creating a new issue, check to ensure the issue hasn't already been reported. When filing an issue, please include:

  • A clear title and description.
  • As much relevant information as possible.
  • A code sample or an executable test case demonstrating the expected behavior that is not occurring.

Conduct

We are committed to providing a welcoming and inspiring community for all. Please take a moment to read our Code of Conduct before participating.

Questions?

If you have any questions, please feel free to ask them on our Github discussions page or reach out directly via GitHub issues.

Thank you for contributing to SocialPredict!