Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 1.71 KB

contributing.md

File metadata and controls

64 lines (41 loc) · 1.71 KB
Raw

Contributing to Suraksha Sakhi

Thank you for your interest in contributing to Suraksha Sakhi! We appreciate your help in making this project better.

Getting Started

To contribute to Suraksha Sakhi, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine:
 git clone https://github.com/your-username/SurakshaSakhi.git
  1. Set up the development environment:
python -m venv .venv
source .venv/bin/activate
  1. Create a new branch for your changes:
git checkout -b feature/your-feature

  1. Make your changes and test them locally.

  2. Commit your changes:

git add .
git commit -m "Add your commit message here"
  1. Push your changes to your forked repository:
git push origin feature/your-feature

  1. Open a pull request:

    • Go to the Suraksha Sakhi repository on GitHub.
    • Click on the "Pull requests" tab.
    • Click on the "New pull request" button.
    • Select your branch and provide a descriptive title and description for your changes.
    • Click on the "Create pull request" button.

Code Style

Please follow the established code style guidelines when contributing to Suraksha Sakhi. This ensures consistency and makes it easier for others to understand and review your code.

Issue Tracker

If you encounter any issues or have suggestions for improvements, please open an issue on the Suraksha Sakhi issue tracker. Be sure to provide as much detail as possible to help us understand and address the problem.

License

By contributing to Suraksha Sakhi, you agree that your contributions will be licensed under the project's license.

Thank you for your contributions!