Skip to content

Commit

Permalink
docs: add important note for contributors before introducing new feat…
Browse files Browse the repository at this point in the history
…ures (#2269)
  • Loading branch information
EchoEllet authored Sep 22, 2024
1 parent ec6931e commit 1583e5d
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# 🌱 Contributing

First, we would like to thank you for your time and efforts on this project, we appreciate it
First, we would like to thank you for your time and efforts on this project, we appreciate it.

> [!IMPORTANT]
> At this time, we prioritize bug fixes and code quality improvements over new features.
> Please refrain from submitting large changes to add new features, as they might
> not be merged, and exceptions may made.
> We encourage you to create an issue or reach out beforehand,
> explaining your proposed changes and their rationale for a higher chance of acceptance. Thank you!
If you don't have anything specific in mind to improve or fix, you can take a look at the issues tab or take a look at
the todos of the project, they all start with `TODO:` so you can search in your IDE or use the todos tab in the IDE.
Expand Down
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,13 @@ Notice that currently, the support for testing is limited.

## 🤝 Contributing

> [!IMPORTANT]
> At this time, we prioritize bug fixes and code quality improvements over new features.
> Please refrain from submitting large changes to add new features, as they might
> not be merged, and exceptions may made.
> We encourage you to create an issue or reach out beforehand,
> explaining your proposed changes and their rationale for a higher chance of acceptance. Thank you!

We greatly appreciate your time and effort.

To keep the project consistent and maintainable, we have a few guidelines that we ask all contributors to follow.
Expand Down

0 comments on commit 1583e5d

Please sign in to comment.