Skip to content

Latest commit

 

History

History
70 lines (53 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

70 lines (53 loc) · 2.78 KB

Contributing to RPArena

Contributing

We welcome contributions from everyone! Whether you're fixing bugs, adding new features, or creating new automation projects, your contributions are valuable. Please follow these guidelines to ensure a smooth contribution process.

How to Contribute

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them: 
    git commit -m "Add your message here"
  4. Push to the branch: 
    git push origin feature/your-feature-name
  5. Create a Pull Request.

Types of Contributions

📚 Improving Documentation

  • Issue: Improve Documentation
  • Description: Enhance the existing documentation to include more detailed explanations, examples, and troubleshooting tips.
  • Tasks:
    • Add detailed explanations for each project.
    • Include code examples and usage instructions.
    • Provide troubleshooting tips for common issues.
    • Update the README.md file with the new information.

🚀 Adding New Automation Projects

  • Issue: Add New Automation Projects
  • Description: Contribute new automation projects to the repository. These can include web scraping, data processing, or any other automation tasks.
  • Tasks:
    • Develop new automation projects.
    • Ensure each project has a clear README.md file with instructions.
    • Include necessary dependencies and setup instructions.
    • Add a small description of the new project to the main README.md file of the repository.

🐛 Fixing and Optimizing Existing Projects

  • Issue: Fix and Optimize Existing Projects
  • Description: Identify and fix bugs in the existing automation projects. Review and optimize the existing code for better performance and readability. Provide detailed descriptions of the bugs and the steps to reproduce them. Suggest improvements and refactor code where necessary.
  • Tasks:
    • Fix the identified bugs.
    • Analyze the current code for performance bottlenecks.
    • Refactor code to improve readability and maintainability.
    • Optimize algorithms and data structures.
    • Update the documentation to reflect the changes.

Adding Details to README.md

When adding new projects or making significant changes, please ensure that the main README.md file is updated with the following details:

  • A brief description of the new project or feature.
  • Instructions on how to use the new project or feature.
  • Any additional setup or dependencies required.

Contact

For any questions or suggestions, please use the repository discussions.

Happy Automating! 🚀