Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
119 lines (89 loc) · 4.35 KB

CONTRIBUTING.md

File metadata and controls

119 lines (89 loc) · 4.35 KB

Contributing to Python Projects for Beginners

First off, thank you for considering contributing to this project! Your support and involvement are greatly appreciated.

How Can You Contribute?

There are several ways you can help improve this repository:

  • Submit Issues: If you find any bugs or have suggestions for improvements, feel free to open an issue.
  • Improve Documentation: Enhancing the documentation, such as adding explanations or clarifying instructions, is always welcome.
  • Add New Projects: Propose new beginner-friendly Python projects that fit the theme of the repository.
  • Enhance Existing Projects: Improve the code, fix bugs, or add features to existing projects.

Getting Started

1. Fork the Repository

Click the "Fork" button at the top-right corner of this repository to create your own copy.

2. Clone Your Fork

git clone https://github.com/behdadbch/Beginner-Python-Projects.git
cd python-projects-for-beginners
3. Create a New Branch
It's good practice to create a new branch for each contribution:

bash
Copy code
git checkout -b feature/your-feature-name
4. Make Your Changes
Follow the Code Style Guidelines when writing code.
Ensure that any new projects are added in their own directory with a descriptive name.
Update the main README.md to include your project in the list.
5. Commit Your Changes
bash
Copy code
git add .
git commit -m "Add Feature: Brief description of your changes"
6. Push to Your Fork
bash
Copy code
git push origin feature/your-feature-name
7. Create a Pull Request
Go to your fork on GitHub and click the "Compare & pull request" button to submit your changes for review.

Code Style Guidelines

To maintain consistency across the projects, please adhere to the following guidelines:

Python Version: Use Python 3.x.
Formatting: Follow PEP 8 style guidelines.
Comments and Docstrings:
Include docstrings for all functions and classes.
Use comments to explain complex logic or algorithms.
Variable and Function Names:
Use meaningful and descriptive names.
Use lowercase with underscores for variable and function names (e.g., calculate_total).
Project Structure Guidelines

When adding a new project:

Create a new directory with a clear and descriptive name (e.g., tic_tac_toe).
Include the following files:
README.md: Explains the project, including description, key concepts, and instructions.
main.py: The main Python script for the project.
requirements.txt: Lists any external libraries needed (if any).
Update the main README.md in the root directory to include your project in the list of projects.
Pull Request Guidelines

Title: Provide a clear and descriptive title for your pull request.
Description: Explain the purpose of your changes.
Reference Issues: If applicable, reference any relevant issues by including phrases like "Closes #issue-number".
Up-to-Date Branch: Ensure your branch is up-to-date with the main branch before submitting.
Reporting Issues

If you encounter any problems or have questions:

Search Existing Issues: Before opening a new issue, check if the issue has already been reported.
Create a New Issue: If it hasn't been reported, open a new issue with a descriptive title and detailed information.
Provide Examples: If applicable, include code snippets or screenshots to illustrate the issue.
Community Guidelines

Be Respectful: Treat others with respect and kindness.
Constructive Feedback: Provide helpful and constructive feedback.
Collaborate: Engage in discussions and be open to different perspectives.
Help Others: Assist fellow contributors by answering questions and providing guidance.
License

By contributing to this repository, you agree that your contributions will be licensed under the repository's MIT License.

yaml
Copy code

---

## Adding the CONTRIBUTING.md to Your Repository

1. **Create the `CONTRIBUTING.md` File**

   - In your repository's root directory, create a new file named `CONTRIBUTING.md`.
   - Paste the content provided above into the file.

2. **Commit and Push the Changes**

   ```bash
   git add CONTRIBUTING.md
   git commit -m "Add Contributing Guide"
   git push origin main
Replace main with your branch name if it's different.

Reference in Your README
It's helpful to mention your Contributing Guide in your main README.md file:

markdown
Copy code
## 🤝 Contributing

Contributions are welcome! Please read the [Contributing Guide](CONTRIBUTING.md) to get started.