Skip to content

Latest commit

 

History

History
54 lines (43 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

54 lines (43 loc) · 1.65 KB
Raw

Contributing to SocialPulse

First off, thank you for considering contributing to SocialPulse! Your help is essential for making this project better.

How to Contribute

1. Fork the Repository

Start by forking the repository on GitHub. This will create a copy of the repository in your account.

2. Clone the Repository

Clone the forked repository to your local machine:

git clone https://github.com/your-username/SocialPulse.git
cd SocialPulse

3. Create a Branch

Create a new branch for your feature or bug fix:

git checkout -b feature/your-feature-name

4. Make Changes

Make your changes to the codebase. Please ensure that your code follows the existing coding style.

5. Write Tests

If applicable, write tests for your new feature or bug fix. We use pytest for testing, and all tests are located in the tests/ directory. Run tests locally to ensure everything works:

pytest

6. Commit Your Changes

Commit your changes with a meaningful commit message:

git add .
git commit -m "Add feature/your-feature-name"

7. Push to GitHub

Push your changes to your forked repository:

git push origin feature/your-feature-name

8. Submit a Pull Request

Go to the original repository and submit a pull request from your forked repository. In your pull request description, please include the following information:

  • A brief explanation of your changes.
  • Any related issue numbers (e.g., "Fixes #123").
  • How your changes were tested.

9. Code Review

Your pull request will be reviewed by the project maintainers. You may be asked to make additional changes before your pull request is merged.