-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |