Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

73 lines (46 loc) · 2.54 KB

Contributing to the Python Packages Guide for Applied Economists

We welcome contributions to improve this guide! Here's how you can help:

How to Contribute

Reporting Issues

If you find any errors or have suggestions for new packages to include:

  • Open an issue in the issue tracker.
  • Provide a clear and descriptive title.
  • Include as much detail as possible about the suggestion or problem.

Submitting Pull Requests

To make changes directly:

  1. Fork the Repository: Click the "Fork" button at the top right of the repository page.

  2. Clone Your Fork: Clone the forked repository to your local machine.

    git clone https://github.com/yourusername/python-packages-for-applied-economists.git

    Replace yourusername with your GitHub username.

  3. Create a New Branch: It's good practice to create a new branch for your changes.

    git checkout -b feature/your-feature-name

  4. Make Your Changes:

    • Edit the GUIDE.md file or other relevant files as needed.
    • Follow the existing structure and format of the guide.
    • Ensure all links are valid and point to the correct resources.
    • Use proper Markdown formatting.

  5. Commit Your Changes:

    git commit -am "Add detailed description of your changes"

  6. Push to Your Fork:

    git push origin feature/your-feature-name

  7. Submit a Pull Request: Go to your fork on GitHub and click the "Compare & pull request" button.

    • Provide a clear and descriptive title for your pull request.
    • In the pull request description, explain what changes you've made and why they should be included.

Contribution Guidelines

  • Consistency: Maintain consistency with the existing style and formatting of the guide.
  • Clarity: Be clear and concise in your descriptions and explanations.
  • Accuracy: Verify the accuracy of the information you provide, including package names, installation commands, and links.
  • Formatting: Use Markdown formatting properly, including headings, lists, code blocks, and links.
  • Language: Use proper spelling and grammar.

Communication

  • If you have any questions or need assistance, feel free to open an issue in the issue tracker.

Thank you for your interest in improving this guide! Your contributions help make this resource more valuable for the community of applied economists using Python.