Skip to content

Commit

Permalink
Merge pull request #1 from PournimaTivatane12/PournimaTivatane12-patch-1
Browse files Browse the repository at this point in the history
Create CONTRIBUTING.md
  • Loading branch information
PournimaTivatane12 authored Oct 8, 2024
2 parents d23835f + 47cddf6 commit 49eab88
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
How to Contribute

1. Fork the Repository
Start by forking the repository.
Clone your forked repository:
git clone https://github.com/PournimaTivatane12/Python-flask-services.git
cd Python-flask-services

2. Set Up Your Development Environment
Ensure you have Python 3.8+ and Flask installed.

Set up a virtual environment:
python3 -m venv env
source env/bin/activate # On Windows, use `env\Scripts\activate`

Install the project dependencies:
pip install -r requirements.txt

3. Making Changes
Create a new branch to work on your changes:

git checkout -b feature-branch
Make your changes and commit them with a descriptive message:

git add .
git commit -m "Brief description of the changes"
Make sure your code follows PEP8 guidelines and passes all existing tests.

4. Running Tests
Run the test suite to ensure your changes do not break existing functionality:
pytest

6. Create a Pull Request
Once you’re done, push your branch to your forked repository:

git push origin feature-branch
Create a pull request from your forked repository to the main branch of the original repository.

Ensure that your PR includes:
A clear description of the changes you’ve made.
Any relevant issue numbers if you’re addressing an existing issue.
Code of Conduct
Please adhere to our Code of Conduct to ensure a welcoming environment for everyone.

Reporting Issues
If you encounter bugs, have suggestions, or would like to request a feature, please open an issue.

0 comments on commit 49eab88

Please sign in to comment.