Skip to content

Latest commit

 

History

History
13 lines (11 loc) · 641 Bytes

CONTRIBUTING.md

File metadata and controls

13 lines (11 loc) · 641 Bytes

Contributing

  1. Clone the git repository
  • git clone https://github.com/siteforge-io/surreal-codegen.git
  1. Run cargo test to run the tests - and this will build the project
  2. Before you start writing code, ideally first open an issue with a minimum reproducible example of the bug or feature you want to add
  3. Using the minimum reproduction, first write a failing test.
  4. Write the code to fix/solve the issue.
  5. Run the tests, and ensure they all pass.
  6. In a fork, perform a git commit, with a message that includes the Closes #issue_number
  7. Submit a pull request
  8. Wait for the pull request to be reviewed and merged