Contribution Guidelines

Thank you for contributing to PreppyData! Your contributions are crucial to improving the platform and providing better features for all users. Please follow the steps below to contribute effectively.

How to Contribute

Note

Follow these steps to ensure your contributions are effective and valuable.

1. Report Issues

If you encounter any bugs or have suggestions for improvements:

Describe the Issue: - Provide a clear and detailed description of the issue. - Include steps to reproduce the problem. - Attach any relevant screenshots or error messages.

Submit the Report: - Open an issue in the GitHub repository.

2. Suggest Features or Improvements

Have an idea to enhance PreppyData?

Outline Your Proposal: - Clearly explain the feature or improvement you’re suggesting. - Describe how it benefits users or enhances the platform.

Submit Your Suggestion: - Open an issue in the GitHub repository.

3. Contribute Code

To contribute code to the project, follow these steps:

Step 1: Fork the Repository - Go to the PreppyData GitHub repository. - Click the “Fork” button in the top-right corner to create a copy of the repository under your GitHub account.

Step 2: Clone Your Forked Repository - Use the URL of your forked repository to clone it to your local machine:

`bash git clone https://github.com/<your-username>/PreppyData.git ` Replace <your-username> with your GitHub username.

Step 3: Navigate to the Project Directory - Move into the project folder:

`bash cd PreppyData `

Step 4: Create a New Branch - Create a new branch to work on your changes:

`bash git checkout -b feature/<your-feature-name> ` Replace <your-feature-name> with a descriptive name for your branch, such as add-user-authentication or fix-bug-123.

Step 5: Make Your Changes - Implement the feature or bug fix. - Follow the Coding Standards outlined below.

Step 6: Commit Your Changes - Stage and commit your changes with a clear message:

`bash git add . git commit -m "Add feature: <brief description>" `

Step 7: Push Your Changes - Push your changes to the branch on your forked repository:

`bash git push origin feature/<your-feature-name> `

Step 8: Create a Pull Request - Go to your forked repository on GitHub. - Click the “Compare & pull request” button. - Provide a clear and concise description of your changes. - Submit the pull request to the original repository at GIPSYDANGER-1/PreppyData.

Coding Standards

To maintain consistency and ensure quality:

  • Programming Language: Python 3.x

  • Style Guide: Follow PEP 8 for Python code.

  • Naming Conventions: - Variables and functions: snake_case - Classes: CamelCase

  • Documentation: - Include docstrings for all modules, classes, and functions. - Add clear comments where necessary.

  • Testing: - Write unit tests for new features or fixes. - Ensure all tests pass before submitting a pull request.

Submission Process

Before submitting your contribution:

  1. Test Thoroughly: - Run all existing tests to confirm your changes do not introduce issues. - Perform manual testing for additional verification if necessary.

  2. Prepare Documentation: - Update or add documentation related to your changes. - Ensure any user-facing updates are reflected in the documentation.

  3. Submit a Clear Pull Request: - Summarize your changes and explain the reasoning behind them. - Reference related issue numbers (e.g., Closes #123).

Contact

If you have any questions or need assistance:

  • Email: woonyko@naver.com

  • GitHub Issues: Use the Issues page for bug reports and suggestions.