Skip to content

Commit

Permalink
feat: Updated CONTRIBUTE.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sweep-ai[bot] committed Mar 12, 2024
1 parent ff8d23a commit e4aa8ab
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion CONTRIBUTE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,23 @@ Contributions are **welcome** and will be fully **credited**. We accept contribu
- **Document any change in behaviour.** Make sure the `README.md` and any other relevant documentation are kept up-to-date.
- **Create feature branches.** Don't ask us to pull from your master branch.
- **One pull request per feature.** If you want to do more than one thing, send multiple pull requests.
- **Send coherent history.** Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
- **Send coherent history.** Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
## Using Matchkits

While the repository does not contain a direct reference to "matchkits," users can interact with the repository's functionality through the CLI or programmatically.

For CLI usage, you can execute scripts within the repository. For example, to run a script from the command line, you might use:

```
php src/Snps/EnsemblRestClient.php --argument1 value1 --argument2 value2
```

For programmatic access, include and utilize classes within your PHP scripts. Here's a simple example:

```php
require_once 'src/Snps/EnsemblRestClient.php';
$ensemblClient = new Dna\Snps\EnsemblRestClient();
$result = $ensemblClient->someMethod();
```

Explore the `src/Snps/` directory for more scripts and classes that can be used from the CLI or programmatically.

0 comments on commit e4aa8ab

Please sign in to comment.