-
-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #27 from Sibam-Paul/docs/add-learn
Docs/added learn
- Loading branch information
Showing
1 changed file
with
70 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
Explore open issues to work on [here](https://github.com/OpenTekHub/cryptobot/issues). | ||
|
||
If you found a bug or have a suggestion, [create a new issue](https://github.com/OpenTekHub/cryptobot/issues/new). | ||
|
||
**🔼 Instructions** | ||
|
||
1. Find or create an [issue](https://github.com/OpenTekHub/cryptobot/issues) to work on. | ||
2. Fork the repository. | ||
3. Create a new branch from the `main` branch using one of the following formats: | ||
- For new features: `feat-[feature-name]` (e.g., `feat-add-login`) | ||
- For bug fixes: `fix-[bug-name]` (e.g., `fix-header-crash`) | ||
4. Make and test your changes. | ||
5. Commit your changes. | ||
6. Submit a PR with a clear title and link the issue in the PR description. | ||
7. Wait for your PR to be reviewed ✔. | ||
|
||
**✅ Guidelines Important MUST READ** | ||
- Before you do pull-request Give ⭐ Star the [Repo](https://github.com/OpenTekHub/cryptobot) | ||
- And Follow the organization [OpenTekHub](https://github.com/[OpenTekHub](https://github.com/OpenTekHub)) | ||
- Ensure you are assigned to an issue or bug before starting development. | ||
- Follow naming standards for issues, pull requests (PRs), and commits. | ||
- Feel free to ask follow-up questions if you're unsure about something! | ||
|
||
**❌ Please Note: Bad Pull Requests Will Not Be Accepted!** | ||
|
||
- Changes that do not address the stated issue or bug will be rejected. | ||
- PRs containing unnecessary indentation changes will not be accepted. | ||
- Do not submit duplicate PRs. | ||
|
||
** ✅How to make a PR** | ||
|
||
1. Fork the repo. | ||
2. After forking, clone the repo to your local machine. To clone the repo to your local machine, run the following command in your terminal: | ||
|
||
``` | ||
git clone https://github.com/<your-github-username>/cryptobot | ||
``` | ||
3. Add a remote upstream to the original repo. To add a remote upstream, run the following command in your terminal: | ||
``` | ||
git remote add upstream https://github.com/Durgesh4993/cryptobot | ||
``` | ||
4. Create a new branch. To create a new branch, run the following command in your terminal: | ||
``` | ||
git checkout -b <your-branch-name> | ||
``` | ||
5. Make changes in source code. | ||
6. Add your changes To add your changes, run the following command in your terminal: | ||
``` | ||
git add -A | ||
``` | ||
7. Commit your changes. To commit your changes, run the following command in your terminal: | ||
``` | ||
git commit -m "<your-commit-message>" | ||
``` | ||
8. Push your changes. To push your changes, run the following command in your terminal: | ||
``` | ||
git push origin <your-branch-name> | ||
``` | ||
9. Create a PR. |