Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 3.37 KB

CONTRIBUTING.md

File metadata and controls

70 lines (50 loc) · 3.37 KB
Raw

Contributing to SyncMaster

Thank you for considering contributing to SyncMaster! We welcome contributions from everyone. Here are some guidelines to help you get started.

How to Contribute

  1. Fork the repository: Click the "Fork" button at the top right of the repository page.
  2. Clone your fork: 
    git clone https://github.com/your-username/SyncMaster.git
  3. Create a branch: 
    git checkout -b your-branch-name
  4. Make your changes: Implement your feature or fix the bug.
  5. Commit your changes: 
    git commit -m "Description of your changes"
  6. Push to your fork: 
    git push origin your-branch-name
  7. Create a Pull Request: Go to the original repository and click "New Pull Request".

Contribution Checklist

Before submitting your pull request, please ensure that you have completed the following checklist. This will help us maintain the quality of the project:

  • Functionality Confirmation: Ensure your code runs smoothly and meets the expected functionality.
  • Demonstration Included: A video demonstrating your solution should be recorded and embedded in the README.
  • Thorough Testing Completed: All standard use cases must be tested successfully.
  • Edge Cases Addressed: Consider and handle additional edge cases.
  • Well-Documented Approach: Provide a clear outline of your approach to solving the problem at the end of this README.

Note: Please update this checklist as you progress with your assignment. Completing all items will facilitate a smoother merging process and help maintain a high standard for the project.

Rules

  • Pull requests can be submitted to any opted-in repository on GitHub or GitLab.
  • The pull request must contain commits you made yourself.
  • If a maintainer reports your pull request as spam, it will not be counted toward your participation in Hacktoberfest.
  • If a maintainer reports behavior that’s not in line with the project’s code of conduct, you will be ineligible to participate.
  • To get a shirt, you must make four approved pull requests (PRs) on opted-in projects between October 1-31 in any time zone.
  • This year, the first 55,000 participants can earn a T-shirt.

A repository/project is considered to be participating in Hacktoberfest if the 'hacktoberfest' topic is present and is accepting public contributions via pull requests. An individual pull request can also be opted-in directly by adding the 'hacktoberfest-accepted' label.

A pull request is considered approved once it has an overall approving review from maintainers, or has been merged by maintainers, or has been given the 'hacktoberfest-accepted' label. A pull request with any label containing the word 'spam' or 'invalid' will be considered ineligible for Hacktoberfest.

Code of Conduct

Please read our Code of Conduct to understand the expectations for behavior when contributing to this project.

Reporting Issues

If you find a bug or have a feature request, please create an issue on the Issues page.

Style Guide

  • Follow the existing code style.
  • Write clear and concise commit messages.
  • Ensure your code passes all tests.

Testing

Please ensure that your changes do not break existing tests and add new tests for new features.

Thank you for your contributions!