Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (43 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

61 lines (43 loc) · 2.16 KB

Contributing Guidelines

Thank you for your interest in contributing to our project! We welcome community contributions and value your feedback. Below are our guidelines for reporting issues and submitting changes.

Reporting Issues

If you encounter bugs or have suggestions for improvements, please help us by opening an issue. When reporting an issue, include:

  • A clear description of the problem or feature request.
  • Steps to reproduce the issue (if applicable).
  • Any relevant screenshots or error logs.

You can open a new issue to get started.

Submitting Pull Requests

We use a standard GitHub workflow for contributions. To submit a pull request:

  1. Fork the Repository
    Click the "Fork" button on our GitHub page to create a copy of the repository in your account.

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

    git clone https://github.com/your-username/your-repo.git

  3. Create a New Branch
    Create a branch for your changes:

    git checkout -b feature/your-feature-name

  4. Make Your Changes
    Implement your changes, keeping in line with the existing code style and conventions.

  5. Commit Your Changes
    Write clear and concise commit messages:

    git commit -m "Add a brief description of your changes"

  6. Push Your Branch
    Push your changes to your fork:

    git push origin feature/your-feature-name

  7. Open a Pull Request
    Navigate to the original repository and open a pull request. Our team will review your submission and provide feedback.

Code Style and Guidelines

  • Follow the existing code style and project conventions.
  • Write clear and meaningful commit messages.
  • Ensure your code is well-documented and tested where applicable.

Additional Resources

For more detailed information on contributing, check out our Developer Documentation and the Mozilla Science Lab article on CONTRIBUTING.md.

Thank you for helping to make this project better!