Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
140 lines (100 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

140 lines (100 loc) · 4.38 KB
Raw

Contributing to DevSphere

DevSphere (logo) (500 x 200 px)

Thank you for considering contributing to DevSphere! We welcome community contributions to improve and expand this project.

💖 Sponsor DevSphere

DevSphere is an open-source project that thrives on community support! If you find this project useful, please consider sponsoring us to help us continue improving and maintaining it.

By becoming a sponsor, you’ll:

  • Support ongoing development and new features
  • Help us keep DevSphere free and open for everyone
  • Get your name or company listed as a sponsor

Sponsor DevSphere

Support DevSphere. Your sponsorship helps us build a better open-source data science platform for everyone. Click the Sponsor button and join our community of supporters!

Table of Contents

How to Contribute

Reporting Issues

If you encounter bugs or have suggestions, please open an issue. When reporting, include:

  • A clear and descriptive title
  • A detailed description of the problem or suggestion
  • Steps to reproduce the issue (if applicable)
  • Any relevant screenshots or logs

Please use the appropriate issue labels (e.g., bug, enhancement, help wanted).

Submitting Pull Requests

We welcome pull requests for bug fixes, new features, and improvements. To submit a pull request:

  1. Fork the repository: Click the "Fork" button at the top right of the repository page.
  2. Clone your fork: 
    git clone https://github.com/your-username/DevSphere.git
  3. Create a new branch: 
    git checkout -b feature/your-feature-name
  4. Make your changes in the new branch.
  5. Commit your changes: 
    git commit -m "Describe your changes briefly"
    • Use clear, concise, and imperative language in commit messages.
    • Reference relevant issues (e.g., Fixes #123).
  6. Push to your fork: 
    git push origin feature/your-feature-name
  7. Open a pull request: Go to the original repository and click "New Pull Request". Fill in the template and provide a clear description.

Example Pull Request Template

### Summary
Briefly describe what this PR does.

### Related Issue(s)
Closes #ISSUE_NUMBER

### Checklist
- [ ] Tests added/updated
- [ ] Documentation updated

Code Style

  • Follow the existing code style and conventions
  • Write clear and concise comments where necessary
  • Ensure your code is well-documented and readable

Testing

  • Ensure your changes do not break any existing functionality
  • Run all tests with: 
    # Replace with your project's test command
pytest
  • If you add new features, include appropriate tests

Documentation

  • Update or add documentation for new features or changed behavior
  • Documentation files are located in the /docs directory
  • If unsure, ask maintainers for guidance

Community Guidelines

  • Be respectful and considerate of others
  • Provide and be open to constructive feedback
  • Follow our Code of Conduct

Contact

Questions or need help? Reach out to the maintainers by:

Additional Resources

Thank you for contributing to DevSphere! Together, we can make this project even better. 🌟

Feel free to adapt this guide to better fit the needs of your project.

Let me know if you want this tailored further, or if you'd like it formatted or customized for specific workflows/tools in your repository!