Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Bruno-366 authored Nov 15, 2024
1 parent d900883 commit 1a2ef09
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Contributing

We welcome contributions to this repository! If you have a property test to add, follow these steps:

1. **Fork the repository** and clone it to your local machine.
2. **Add a new property test**: Create a new `.md` file under the `property-tests` directory. Add tests relevant to the data structure or algorithm you're targeting.
3. **Follow best practices**: Ensure that your property tests are written in a clear, understandable format. See the existing tests for examples.
4. **Submit a pull request**: Once you've added your test(s), open a pull request with a brief description of your changes.
5. **Test your code**: If applicable, provide links to the relevant property testing framework or language-specific tools used to verify your tests.

## Best Practices

- **Keep tests simple**: Focus on one property per test.
- **Provide clear explanations**: Describe the property you're testing and the reasoning behind it.
- **Document the tool or framework**: If your property test requires a specific framework, be sure to mention it.

## Reporting Issues

If you encounter any broken tests or have suggestions for additional properties to test, feel free to [open an issue](https://github.com/Forward-Lang/awesome-property-testing/issues).
We're always looking for ways to improve the repository.

0 comments on commit 1a2ef09

Please sign in to comment.