Skip to content

Commit 449a22a

Browse files
author
F.
committed
{feat) docs
1 parent 60edfa3 commit 449a22a

File tree

3 files changed

+66
-3
lines changed

3 files changed

+66
-3
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Contributing Guidelines
22

3-
Thank you for being so interested in contributing to this bridge bwtween Telegram and Discord. I appreciate your willingness to share your knowledge and experience with me.
3+
Thank you for being so interested in contributing to the `ewrap` package. I appreciate your willingness to share your knowledge and experience with me.
44

5-
The goal of this projet is to automate the process of sending messages from Telegram to Discord and soon other sources. This project is still in its early stages and I am looking for smart contributors to help me improve it.
5+
Here is a brief guideline about how you can help improving the library, adding new features, fixing bugs.
66

77
## How to Contribute
88

@@ -35,7 +35,7 @@ To ensure that contributions are consistent and aligned with the project's objec
3535

3636
**Provide Detailed Information:** When reporting issues or submitting pull requests, provide as much relevant information as possible. This will help maintainers and other contributors understand your changes or your problems.
3737

38-
**Respect Others:** Be kind and respectful towards other community members. Avoid disrespectful language and behaviour.
38+
**Respect Others:** Be kind and respectful towards other community members. Avoid disrespectful language and behavior.
3939

4040
## Conclusion
4141

docs/docs/contributing.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing Guidelines
2+
3+
Thank you for being so interested in contributing to the `ewrap` package. I appreciate your willingness to share your knowledge and experience with me.
4+
5+
Here is a brief guideline about how you can help improving the library, adding new features, fixing bugs.
6+
7+
## How to Contribute
8+
9+
### Reporting Issues
10+
11+
One of the simplest ways to contribute is by reporting issues. If you encounter a problem with one of the tools, find a mistake in the documentation, or believe that a best practice needs to be updated, please open an issue on our GitHub repository.
12+
13+
### Submitting Changes
14+
15+
If you want to directly contribute to the project by adding new tools, updating documentation, or proposing new best practices, follow these steps:
16+
17+
- **Fork the Repository:** Start by forking the project repository into your GitHub account.
18+
- **Create a Branch:** Create a new branch in your forked repository. It's good practice to name the branch according to the feature or fix you're implementing.
19+
- **Make Your Changes:** Add, edit, or delete files in your branch to implement the changes you want to make.
20+
- **Commit Your Changes:** Make sure to write clear, concise commit messages describing your changes.
21+
- **Push Your Changes:** Push your branch and its new commits to your forked repository on GitHub.
22+
- **Create a Pull Request:** Open a pull request from your forked repository to the main project repository. Please provide a detailed description of the changes you've made and the reasons behind them.
23+
24+
## Reviewing Pull Requests
25+
26+
Another way to contribute is by reviewing pull requests submitted by others. Look over the proposed changes, test them if possible, and leave feedback.
27+
28+
## Contribution Guidelines
29+
30+
To ensure that contributions are consistent and aligned with the project's objectives, please follow these guidelines:
31+
32+
**Respect the Project's Scope:** All contributions should aim to improve the service stability, security, performance. Contributions that align with this objective may be accepted.
33+
34+
**Follow Best Practices:** When contributing code, adhere to the coding style and practices established in the project.
35+
36+
**Provide Detailed Information:** When reporting issues or submitting pull requests, provide as much relevant information as possible. This will help maintainers and other contributors understand your changes or your problems.
37+
38+
**Respect Others:** Be kind and respectful towards other community members. Avoid disrespectful language and behavior.
39+
40+
## Conclusion
41+
42+
Participating in open-source projects like this one can be an enriching experience. You have the opportunity to enhance your abilities while also making a valuable contribution to a resource that positively impacts the greater community.

docs/docs/license.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# MIT License
2+
3+
Copyright (c) 2024
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)