Skip to content

[CONFIG] new contributing guidelines #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing to this project

Welcome, and thank you for your interest in contributing!

The goal of this document is to provide a high-level overview of
how you can contribute and explain how we accept contribution.

## Reporting issues

Please use [the repository issue tracker](https://github.com/sir-gon/algorithm-exercises-ts/issues)
to report any issues..

## Providing feedback or suggestions

Similarly to bug reports, we accept improvement suggestions and feedback via
[the repository issue tracker](https://github.com/sir-gon/algorithm-exercises-ts/issues).

## Contributing code changes

We are thrilled that you are interested in contributing code changes!

You can make your own fork an next, make your increment.
You only need to meet the following requirements for new contributions:

* Any new increment MUST have a related test
with high (or preferred full) coverage.
* Use Clean Code principles.

Once we've confirmed that we're ready to accept your contribution,
feel free to open a pull request and link it in the issue ticket.

I will be happy to receive new contributions!

## Code of Conduct

Please make sure to read and follow the [Code of Conduct](./CODE_OF_CONDUCT.md).