Skip to content

Commit

Permalink
add contr md
Browse files Browse the repository at this point in the history
  • Loading branch information
Boris Zhguchev committed Oct 2, 2023
1 parent 4aee3c3 commit 6a19833
Showing 1 changed file with 6 additions and 13 deletions.
19 changes: 6 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,17 @@

Thank you for your interest in contributing to Forester!

Table of Contents:

1. [Feature Requests](#feature-requests)
2. [Bug Reports](#bug-reports)
3. [Patches / Pull Requests](#patches--pull-requests)
1. [Testing](#testing)
2. [Performance](#performance)
3. [Documentation](#documentation)
4. [Style](#style)
4. [Release Process](#release-process)
5. [Contact](#contact)

## Feature Requests and Bug Reports

Feature requests should be reported in the
[issue page](https://github.com/besok/forester/issues). To reduce the number of
duplicates, please make sure to check the existing issues.

In general, the future request are labeled with 'enhancement' label and 'bug' label for bug reports.

If the story is not clear or big or supposed to be discussed and then broken down into the independent tasks,
it should be labeled with 'design' label.

## Patches / Pull Requests

All patches have to be sent on Github as [pull requests](https://github.com/besok/forester/pulls).
Expand All @@ -32,7 +25,7 @@ list of [issues](https://github.com/besok/forester/issues).
To make sure no regressions were introduced, all tests should be run before sending a pull request.
The following command can be run to test Alacritty:

Additionally if there's any functionality included which would lend itself to additional testing,
Additionally, if there's any functionality included which would lend itself to additional testing,
new tests should be added. These can either be in the form of Rust tests using the `#[test]`
annotation.

Expand Down

0 comments on commit 6a19833

Please sign in to comment.