-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
76 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
# Contributing to TechBlog | ||
|
||
Thank you for considering contributing to TechBlog! We welcome all contributions that help improve the project, whether it's fixing bugs, adding features, or improving documentation. | ||
|
||
## How to Contribute | ||
|
||
### 1. Fork the Repository | ||
Start by forking the repository to your GitHub account. | ||
|
||
```bash | ||
git clone https://github.com/Mayen007/TechBlog.git | ||
cd TechBlog | ||
``` | ||
|
||
### 2. Set Up the Development Environment | ||
Ensure you have Python installed and create a virtual environment: | ||
|
||
```bash | ||
python -m venv venv | ||
source venv/bin/activate # On Windows use `venv\Scripts\activate` | ||
``` | ||
|
||
Install dependencies: | ||
|
||
```bash | ||
pip install -r requirements.txt | ||
``` | ||
|
||
### 3. Create a New Branch | ||
Always work on a new branch for your contributions: | ||
|
||
```bash | ||
git checkout -b feature-name | ||
``` | ||
|
||
### 4. Make Changes & Test | ||
- Follow best practices and maintain code readability. | ||
- Test your changes before committing. | ||
|
||
### 5. Commit Your Changes | ||
Commit your changes with a clear message: | ||
|
||
```bash | ||
git add . | ||
git commit -m "Add feature-name" | ||
``` | ||
|
||
### 6. Push to GitHub | ||
Push your branch to GitHub: | ||
|
||
```bash | ||
git push origin feature-name | ||
``` | ||
|
||
### 7. Create a Pull Request | ||
Go to the original repository and create a **Pull Request (PR)** with a clear description of your changes. | ||
|
||
## Contribution Guidelines | ||
- Follow PEP8 for Python code style. | ||
- Use meaningful commit messages. | ||
- Ensure your code does not break existing functionality. | ||
- Document any new features in the README if necessary. | ||
|
||
## Reporting Issues | ||
If you find a bug or have a feature request, create an issue with: | ||
- A clear title | ||
- Steps to reproduce (if applicable) | ||
- Expected vs. actual behavior | ||
- Screenshots (if relevant) | ||
|
||
## Code of Conduct | ||
Please follow our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a welcoming community for everyone. | ||
|
||
## Need Help? | ||
If you have any questions, feel free to open an issue or start a discussion. We appreciate your contributions! 🚀 | ||
|