Skip to content

contribution_guide.md

Latest commit

 

History

History
22 lines (19 loc) · 1.3 KB

contribution_guide.md

File metadata and controls

22 lines (19 loc) · 1.3 KB

Contribution Guide

The OceanSim project is open-source and welcomes contributions from the community. We accept contributions in the form of PR(Pull Requests) and issues.

What is PR

PR is the abbreviation of Pull Request. Here's the definition of PR in the official document of Github.

Submit a PR to OceanSim

  1. Fork the repository
  2. Clone the forked repository to your local machine
  3. Create a new branch for your changes
  4. Make your changes and commit them
  5. Push your changes to your forked repository
  6. Create a pull request to the original repository

PR Guidelines

  • Please make sure your code is well-documented and follows the coding style of the project.
  • We would appreciate if you can provide clear and significant commit message.
  • Provide clear and meaningful PR description.
    • Task name should be clarified in title. The general format is: [Prefix] Short description of the PR (Suffix)
    • Prefix: add new feature [Feature], fix bug [Fix], related to documents [Docs]
    • Introduce main changes, results and influences on other modules in short description
    • Associate related issues, discussion, and pull requests with a milestone