Skip to content

Commit

Permalink
[issue 9] - Simplify and improve project docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fabiobrz committed Nov 16, 2023
1 parent e482315 commit cf437e2
Show file tree
Hide file tree
Showing 3 changed files with 316 additions and 445 deletions.
32 changes: 5 additions & 27 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,43 +5,21 @@ Thank you for contributing to [Intersmash](https://github.com/Intersmash/intersm
Try to follow used patterns and submit a clean PR that fix ideally one issue.
A new unit test has to be part of the PR in case the change is related to a shared code base.

## Console logging level
Use `console-log-level` environment variable to control the console log level threshold (defaults to `INFO`).

## Adding code

To include new code into this project please open a pull request against the `main` branch with the following template:

```text
[Description of the PR]
To include new code into this project please open a pull request against the `main` branch by referencing the
issue that tracks the work.

Please make sure your MR meets the following requirements:
* [ ] Pull Request contains a description of the changes
* [ ] Pull Request does not include fixes for multiple issues/topics
* [ ] Code is self-descriptive and/or documented
```
### Adding tooling code

- The changes must be tracked by a [GitHub issue](https://github.com/Intersmash/intersmash/issues)
so open one to manage Intersmash feature requests, requests for enhancements and bugs.
- Open a PR referencing the GitHub issue
- Open a PR referencing the GitHub issue, e.g.: _[issue 9] - Reorgaanize project docs_

#### Creating an issue

To report an issue with this project, please open a new [GitHub issue](https://github.com/Intersmash/intersmash/issues)
using the following template:

```text
[Description of the issue]
```
If the issue represents a requirement for a feature or enhancement request, please add text to provide a rationale for it.

If the issue is about a bug, please to use the follow template:
```text
* Environment: [description of environment where this issue occurs]
* Steps to reproduce: [command(s) which can be run to reproduce the failure (including -Dtest option if applicable)]
```
To report an issue with this project, please open a new [GitHub issue](https://github.com/Intersmash/intersmash/issues).
Choose the proper template and fill it with the required information.

### Code conventions

Expand Down
Loading

0 comments on commit cf437e2

Please sign in to comment.