Skip to content

Latest commit

 

History

History
91 lines (60 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

91 lines (60 loc) · 3.52 KB
Raw

Contributing Guidelines

Welcome! Thanks for taking the time to contribute.

The following guidelines will help you understand how you can contribute to this project effectively.

Table of Contents

Getting Started

If you are looking to do feature enhancements, bug fixes, documentation improvements, etc (ie contributing to the source code), please follow these steps:

  1. Fork the repository.
  2. Clone your forked repository to your local machine.
  3. Install the project dependencies.
  4. Create a new branch for your contribution.
  5. Make your desired changes.
  6. Test your changes locally to ensure they work as expected.
  7. Submit a pull request from your forked repository to the main project repository.

If you are just looking to report bugs or make feature requests, submit an issue.

Submitting Contributions

When submitting a pull request, please ensure the following:

  • Provide a clear and descriptive title for your pull request.
  • Include a detailed description of the changes you've made.
  • Reference any relevant issues or pull requests in your description.

I will review your pull request as soon as possible, and may provide feedback or request further changes before merging your contribution.

Code Style Guidelines

Please adhere to the following code style guidelines when contributing:

  • Follow the existing code formatting conventions.
  • Write clear and concise code with meaningful variable and function names.
  • Comment your code when necessary to explain its purpose or complex logic.

Issue and Bug Reports

If you encounter an issue or bug while using the project, please submit an issue. When submitting an issue:

  • Provide a clear and descriptive title.
  • Describe the steps to reproduce the issue.
  • Include any relevant error messages/logs/screenshots.
  • Include any additional context or information that might be helpful in resolving the issue.

Feature Requests

I always welcome suggestions for new features or enhancements. To submit a feature request:

  • Provide a clear and descriptive title.
  • Describe the new feature or enhancement you would like to see.
  • Explain why you believe it would be beneficial to the project.

Community Guidelines

To ensure a welcoming and inclusive community, please adhere to the following guidelines:

  • Be respectful and considerate in all interactions.
  • Avoid offensive or discriminatory language.
  • Help and support others in the community.
  • Be open to constructive feedback and ideas.
  • Report any inappropriate behavior or violations of the guidelines to the project maintainers.

Contact

If you have any questions or need further assistance, you can reach me at brandon.li@berkeley.edu.

Thank you for your contributions!

Copyright © Brandon Li. All Rights Reserved.  |  See the LICENSE (MIT).