Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 2.92 KB
Raw

Contribution Guidelines

Thank you for your interest in contributing to Uni-Dock! We value your time and effort, and aim to make the contribution process enjoyable and efficient. To ensure consistency and maintainability, please follow these guidelines when submitting your contributions.

Troubleshooting

If you encountered problems using Uni-Dock, please refer to our GitHub issue tracker, and check if it is a known problem. If you found a bug, you can help us improve by submitting a new issue to our GitHub Repository. Provide a clear and concise title and description, including steps to reproduce the issue (if applicable) and any relevant context. Even better, you can submit a Pull Request with a patch.

Feature requests

We highly appreciate your contributions, and would like to help you crafting the changes and making contributions to the community. If you would like to implement a new feature, please submit a feature requesting issue with a proposal for your work first. This help fitting your ideas and work with the development road map well, coordinating our efforts, and avoiding duplication of work.

Submitting a Pull Request

Please fork your own copy of the Uni-Dock repository, and draft your changes there. Once the modified codes work as expected, please submit a pull request to merge your contributions.

  1. Fork the Uni-Dock repository. If you already had an existing fork, sync the fork to keep your modification up-to-date.

  2. Pull your forked repository, create a new git branch, and make your changes in it:

    git checkout -b bug-fix

  3. Coding your patch and commit the changes.

  4. Push your branch to GitHub:

    git push origin my-fix-branch

  5. On GitHub, create a pull request (PR) from your bug-fix branch targeting dptech-corp/Uni-Dock.

  6. After your pull request is merged, you can safely delete your branch and sync the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-fix-branch

  • Check out the master branch:

    git checkout develop -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream develop