Skip to content

Latest commit

 

History

History
75 lines (47 loc) · 3.79 KB

CONTRIBUTING.md

File metadata and controls

75 lines (47 loc) · 3.79 KB

Contributing to the Spotify Dashboard

Thank you for considering contributing to the Spotify Dashboard! We appreciate your interest in helping us improve our project. By participating in this project, you agree to abide by the Code of Conduct.

How to Contribute

There are several ways you can contribute to the Spotify Dashboard, including but not limited to:

  • Reporting bugs
  • Suggesting enhancements
  • Writing code patches
  • Reviewing pull requests
  • Improving documentation
  • Providing translations
  • Sharing your experience with others

Getting Started

To contribute to the Spotify Dashboard, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone your fork of the repository to your local machine.
  3. Create a branch for your changes based on the main branch.
  4. Make your changes and commit them to your branch.
  5. Push your changes to your fork on GitHub.
  6. Open a pull request in the original repository and describe your changes.

Bug Reports

If you encounter a bug while using the Spotify Dashboard, please follow these steps to report it:

  1. Check the existing issues to see if the bug has already been reported.\
  2. If it hasn't been reported, create a new issue and provide detailed information about the bug, including steps to reproduce it.

Feature Requests

If you have an idea for a new feature or enhancement, please follow these steps to suggest it:

  1. Check the existing issues to see if the feature has already been requested.
  2. If it hasn't been requested, create a new issue and describe the feature you'd like to see.

Code Contributions

We welcome code contributions to the Spotify Dashboard. If you'd like to contribute code, please follow these steps:

  1. Follow the Getting Started instructions above.
  2. Ensure your code follows the project's code style and conventions.
  3. Write unit tests to cover your changes.
  4. Make sure all tests pass before submitting a pull request.

Code of Conduct

Please note that by participating in this project, you agree to abide by the Code of Conduct. We are committed to providing a welcoming and inclusive environment for all contributors.

Contact

If you have any questions or need further assistance, feel free to contact us at nijiati@email.com, kulaphong@email.com, or cadlam87@gmail.com.

Thank you for your interest in contributing to the Spotify Dashboard!

Workflow Practices

Continuous integration: TBD
Workflow: Branching workflow
Group size: 3

All group members utilized a simple branching model that revolved around a single main branch. This helped facilitate collaboration, code review, and continuous integration when developing the Spotify Dashboard. Each group member was responsible for carrying out the tasks of developing specific visualizations in dash that helped contribute to an overall visualization dashboard in Python code using Spotify dataset(s).

Nijiati Abulizi: track and genre information visualization(s), Proposal.md

Kulaphong Jitareerat: audio features visualization(s), README.md

Craig Adlam: popularity metrics visualization(s), CONTRIBUTING.md

All group members should be able to collaborate throughout the development stages by meeting in person as well as interacting online. Each member contributed to designing layout and supportive documentation.