Skip to content

Latest commit

 

History

History
226 lines (143 loc) · 9.13 KB

CONTRIBUTING.md

File metadata and controls

226 lines (143 loc) · 9.13 KB

Contributing to the Python Projects Repository

Thank you for your interest in contributing to the Python Projects Repository! Your contributions help improve the quality and diversity of the projects in this repository. Whether you want to suggest an improvement, report a bug, or add a new project, your contributions are highly appreciated.

image How to Contribute

To contribute to this repository, please follow these steps:

1. Star The Repo

Star the repo by pressing the top most-right button to start your wonderful journey

star repo

2. Fork the repository

Click the "Fork" button on the top right corner of this page to create a copy of the repository in your GitHub account.

fork image

3. Clone the forked repository
  • Method 1: GitHub Desktop

⚠️ NOTE: If you're not familiar with Git, using GitHub Desktop Application is a better start. If you choose this method, make sure to download it before continuing reading.

❗❗ Access link to download here.

Learn more about how to clone the remote respository on your local machine using GitHub Desktop here.

  • Method 2: Git

Use the following command to clone the forked repository to your local machine

git clone https://github.com/vrm-piyush/Python-Projects.git

This makes a local copy of the repository in your machine.

Learn more about forking and cloning a repo.

4. Create a new feature branch

Always keep your local copy of the repository updated with the original repository. Before making any changes and/or in an appropriate interval, follow the following steps:

  • Method 1: GitHub Desktop

Learn more about how to create new branch here and how to fetch and pull origin from/to your local machine here.

Learn more about how to fetch and pull origin from/to your local machine using GitHub Desktop here.

  • Method 2: Git

Run the following commands carefully to update your local repository

# If you cloned a while ago, get the latest changes from upstream
git checkout <master>
git pull upstream <master>

# Make a feature branch (Always check your current branch is up to date before creating a new branch from it to avoid merge conflicts)
git checkout -b <feature-branch-name>

#
5. Make your changes
  • Create a folder in projects directory according to your project name.

    The folder name should follow the following format "YourProjectNameHere". For example: DiceStimulator

  • Write your code and add to the respective folder in the projects directory, locally.
  • Don't forget to add a README.md in your folder, according to the README_TEMPLATE.

Implement your changes or additions to the project and commit them to your branch:

git add .
git commit -m "Your descriptive commit message"
6. Push your changes

Push your branch to your forked repository with the following command:

git push origin feature-branch-name
7. Open a pull request (PR)
  • Method 1: GitHub Desktop

Learn more how to pull request from your local machine using GitHub Desktop to the main repo here.

  • Method 2: Git

Go to the GitHub page of your fork, and make a pull request:

pull request image

Read more about pull requests on the GitHub help pages.

Now wait, until your Pull Request is approved! If there are any conflicts, you will get a notification.

Reporting Bugs

If you encounter any bugs or issues with the projects in this repository, please open an issue on the GitHub issue tracker. Provide detailed information about the bug, including steps to reproduce it and any relevant error messages. Please make sure to follow the bug tempalte.

Feature Requests

If you have ideas for new projects or features to add to existing projects, feel free to open an issue on the GitHub issue tracker. Describe your idea or feature request in detail, and it will be considered for future development. Please make sure to follow the feature request.

Guidelines

When contributing to the projects in this repository, please follow these guidelines to ensure a smooth development process and maintain code consistency across the repository.

Code Style

To ensure that your contributions are accepted with ease, please follow these guidelines:

  • Follow PEP 8 guidelines: Adhere to the PEP 8 style guide for Python code.
  • Create a new folder for each project: Each project should have its own folder in the repository.
  • Use clear and descriptive names: Choose meaningful variable and function names.
  • Write docstrings: Document functions and modules as needed for clarity.
  • Use comments: Explain complex sections of code with comments for better understanding.
  • Include a README: Each project should include a README file that describes the project and how to run it.
  • Avoid hardcoding: Use variables and configuration files to avoid hardcoding values.
  • Test your code: Ensure that your code is correct and runs without errors before submitting a PR.

Git

  • Create a new branch: Always create a new branch for your changes.
  • Keep your branch updated: Regularly update your branch with the main branch to avoid conflicts.
  • Write descriptive commit messages: Provide a clear and descriptive commit message for each commit.
  • Follow the pull request template: Use the pull request template when opening a pull request.
  • Follow the code review guidelines: Respond to code reviews and make changes as needed.
  • Keep pull requests small: Submit small pull requests with a single change instead of multiple changes.
  • Close issues with pull requests: Reference the issue number in the pull request description to close the issue automatically.

Issues

  • Search for existing issues: Check the issue tracker to see if someone has already reported the issue or suggested the feature.
  • Provide detailed information: Include detailed information about the issue or feature request to help others understand it.
  • Follow the template: Use the issue template to provide the necessary information and context for your issue.

Support

If you have any questions or need assistance with your contributions, feel free to reach out to the repository owner or open an issue on the repository. Your feedback and suggestions are welcome!

License

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

Code of Conduct

Please read the Code of Conduct before contributing to this repository. This code outlines the expectations for all contributors and maintainers of this repository.

Resources

Contributors

A big thank you to all the contributors who have helped improve this repository with their suggestions and contributions!

Contact

If you have any questions or need further assistance, feel free to contact me.