Skip to content

Latest commit

 

History

History
86 lines (61 loc) · 2.66 KB

CONTRIBUTING.md

File metadata and controls

86 lines (61 loc) · 2.66 KB

Contributing to Particle Network Background

First off, thank you for considering contributing to the Particle Network Background project! It's people like you that make this project such a great tool.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots if possible
  • Include your environment details (OS, browser version, etc.)

Suggesting Enhancements

If you have a suggestion for a new feature or enhancement:

  • Use a clear and descriptive title
  • Provide a detailed description of the suggested enhancement
  • Explain why this enhancement would be useful
  • Include code examples if applicable
  • Add mockups or examples if possible

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible
  • Follow our coding standards
  • Document new code
  • End all files with a newline

Development Process

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

JavaScript Styleguide

  • Use 2 spaces for indentation
  • Use semicolons
  • Use camelCase for variable and function names
  • Add comments for complex logic
  • Keep functions focused and small
  • Use meaningful variable names

CSS Styleguide

  • Use 2 spaces for indentation
  • Use kebab-case for class names
  • Group related properties
  • Use shorthand properties where possible
  • Add comments for complex selectors

Setting Up Your Development Environment

  1. Clone your fork of the repository
  2. Install any necessary dependencies
  3. Create a new branch for your feature
  4. Make your changes
  5. Test your changes thoroughly
  6. Submit a pull request

Community

  • Join our discussions in the issues section
  • Follow our GitHub repository
  • Share the project with others

Questions?

If you have any questions, please feel free to contact us or open an issue.

Thank you for contributing! 🎉