Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
87 lines (65 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

87 lines (65 loc) · 2.34 KB

Contributing to UPENN-PNGC

Thank you for your interest in contributing to UPENN-PNGC projects! We welcome contributions from the community.

How to Contribute

Reporting Issues

If you find a bug or have a suggestion for improvement:

  1. Search existing issues to see if your issue has already been reported
  2. If not found, create a new issue with a clear title and description
  3. Include as much relevant information as possible:
    • Steps to reproduce (for bugs)
    • Expected vs. actual behavior
    • Your environment (OS, software versions, etc.)
    • Screenshots or error messages if applicable

Submitting Changes

  1. Fork the repository to your own GitHub account
  2. Clone your fork locally 
    git clone https://github.com/your-username/repository-name.git
  3. Create a new branch for your changes 
    git checkout -b feature/your-feature-name
  4. Make your changes following our coding standards
  5. Test your changes thoroughly
  6. Commit your changes with clear, descriptive commit messages 
    git commit -m "Add feature: brief description"
  7. Push to your fork 
    git push origin feature/your-feature-name
  8. Open a Pull Request against the main repository

Pull Request Guidelines

  • Provide a clear description of the changes
  • Reference any related issues
  • Ensure all tests pass
  • Keep changes focused and atomic
  • Follow the existing code style
  • Update documentation as needed

Development Setup

Refer to the individual repository's README for specific setup instructions.

Code Style

  • Follow the existing code style in the project
  • Use meaningful variable and function names
  • Comment complex logic
  • Keep functions small and focused

Testing

  • Write tests for new features
  • Ensure existing tests pass
  • Aim for good test coverage

Code Review Process

  1. Maintainers will review your pull request
  2. Address any feedback or requested changes
  3. Once approved, your PR will be merged

Community

  • Be respectful and constructive
  • Follow our Code of Conduct
  • Ask questions if you're unsure about anything

Questions?

If you have questions, please:

  • Check the repository's documentation
  • Review existing issues and discussions
  • Refer to our Support Guidelines

Thank you for contributing!