Skip to content

Latest commit

 

History

History
74 lines (56 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

74 lines (56 loc) · 4.12 KB
Raw

Contribution Guidelines

Thank you for contributing to our project! Please follow these guidelines before submitting a pull request (PR).

  • If you have any suggestions for the projects, like reporting a bug, improving UI/UX, or enhancing the README.md file, feel free to open an issue to discuss it.
  • Please ensure your pull request adheres to good practices and standards.
  • Pleae ensure your pull request have reference to the issue assigned.
  • Please make sure you check your spelling and grammar.
  • Create individual Pull Requests for each issues.

Setup Instructions

  1. Clone the repository to your local machine.
  2. Install dependencies using npm install or yarn install, depending on your package manager.
  3. Set up any necessary configuration files (if applicable).

Code Guidelines

  1. Write clear and concise code with meaningful variable names and comments where necessary.
  2. Ensure backward compatibility and avoid breaking changes.

Testing Procedures

  1. Run unit tests using npm test or yarn test to ensure new code passes all tests.
  2. Include test cases for new features or bug fixes.
  3. Perform manual testing if applicable, especially for UI changes.

PR Guidelines

  1. Create a new branch for your changes (git checkout -b #issue number).
  2. Reference the related issue in your PR description using the format Fixes #issue_number.
  3. Provide a clear and detailed description of your changes.
  4. Include screenshots or GIFs for UI changes if relevant.
  5. Update documentation if your changes impact existing documentation.

Review Checklist

  1. Complete code review and address any feedback.
  2. Ensure all tests pass, and new code doesn't introduce regressions.
  3. Double-check code formatting, naming conventions, and documentation.
  4. Verify that your PR meets the project's acceptance criteria.

Alternatively, contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the Spring-Music-Player repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the Spring-Music-Player repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the Spring-Music-Player repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the Spring-Music-Player repository.

Contact Information

If you have any questions or need assistance, you contact me on https://discord.gg/UAC2Ys2m or open an issue for discussion.

We appreciate your contributions to the project!