Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

42 lines (24 loc) · 2.24 KB

Contributing to Python Scripts Repository

We welcome and appreciate contributions to this repository of Python scripts. Whether you're fixing a bug, adding a new feature, or improving documentation, we're grateful for your help!

Code Formatting

We use Black to enforce a consistent code style. To run the formatter, make sure you have Black installed and then run the following command in the root directory of the repository:

make format

Please make sure that all code changes are formatted with Black before submitting a pull request.

Here is a step-by-step guide for contributing to the python-scripts repository:

  1. Fork the repository: Visit the python-scripts repository at https://github.com/yashikakhurana/python-scripts, click the "Fork" button in the top right corner, and choose the account where you want to fork the repository.

  2. Clone the repository: Clone your fork of the repository to your local machine using the following command: $ git clone https://github.com/[YOUR_USERNAME]/python-scripts.git

  3. Create a new branch: Create a new branch on your local machine to make your changes. $ git checkout -b [BRANCH_NAME]

  4. Make changes and commit them: Make the necessary changes to the scripts, and commit your changes to the new branch. $ git add [FILE_NAME] $ git commit -m "Add [SHORT_DESCRIPTION_OF_CHANGES]"

  5. Push changes to your fork: Push your changes to your fork of the repository. $ git push origin [BRANCH_NAME]

  6. Create a pull request: Go to the python-scripts repository on GitHub and click the "Compare & pull request" button. Fill out the pull request form with a description of your changes and submit the pull request.

Please make sure that your changes follow the existing coding style and that you've written tests to cover your changes.

Code of Conduct

We are committed to creating a welcoming and inclusive environment for everyone who participates in this repository. Please read and follow our Code of Conduct.

License

By contributing to this repository, you agree to license your contributions under the MIT License.

Thank you for your help, and we're looking forward to working with you!