Skip to content

Latest commit

 

History

History
19 lines (17 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

19 lines (17 loc) · 1.17 KB

Contributing

If you want to contribute to CustomMatPlot and make it better, your help is very welcome!

How to make a clean pull request

  • Create an issue or feature request here.
  • Create a personal fork of the project on Github.
  • Clone the fork on your local machine. Ensure that your remote repository on Github is called origin.
  • Add the original repository as a remote called upstream.
  • Create a new branch from the master branch.
  • Implement your feature or fix the issue.
  • Use Github Copilot, ChatGPT, or your favorite llvm to check for code smells, architecture issues, or bad logic.
  • Format your Cpp code with ClangFormat style: Google.
  • Create a test for your fix, if possible (currently, only manual tests are available).
  • Push your branch to your fork on Github, which is the remote origin.
  • From your fork, open a pull request to the master branch.
  • Provide a short description of what the PR solves, and link the PR with the issue it addresses.
  • 1 approval is required for merging.