Skip to content
This repository was archived by the owner on May 22, 2024. It is now read-only.

Commit 911816d

Browse files
author
KrazyKirby99999
authored
Merge pull request #109 from KrazyKirby99999/contributing
Improve contributing.md
2 parents 5e67c28 + e988dea commit 911816d

File tree

1 file changed

+5
-38
lines changed

1 file changed

+5
-38
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,23 @@
11
# How can I contribute?
22

3-
Thank you for taking your time to view and possibly contribute to SImple-Matrix-Bot-Lib!
3+
Thank you for taking your time to view and possibly contribute to simplematrixbotlib!
44

55
### Reporting Bugs
66

7-
To report a bug in Simple-Matrix-Bot-Lib, select the bug report template from [here](https://github.com/KrazyKirby99999/simple-matrix-bot-lib/issues/new/choose) and replace the default and blank values with the appropriate information. You can also join Simple-Matrix-Bot-Lib's Matrix room located at [#simplematrixbotlib:matrix.org](https://matrix.to/#/#simplematrixbotlib:matrix.org) to discuss your problem with members.
7+
To report a bug in simplematrixbotlib, select the bug report template from [here](https://github.com/KrazyKirby99999/simple-matrix-bot-lib/issues/new/choose) and replace the default and blank values with the appropriate information. You can also join simplematrixbotlib's Matrix room located at [#simplematrixbotlib:matrix.org](https://matrix.to/#/#simplematrixbotlib:matrix.org) to discuss your problem with members.
88

99
### Suggesting Features
1010

11-
To suggest a feature for Simple-Matrix-Bot-Lib, select the feature request template from [here](https://github.com/KrazyKirby99999/simple-matrix-bot-lib/issues/new/choose) and add clear and precise details concerning your suggestion.
11+
To suggest a feature for simplematrixbotlib, select the feature request template from [here](https://github.com/KrazyKirby99999/simple-matrix-bot-lib/issues/new/choose) and add clear and precise details concerning your suggestion.
1212

1313
### Improving the Source Code
1414

15-
If you want to contribute to Simple-Matrix-Bot-Lib, the most direct method is to improve the source code.
15+
If you want to contribute to simplematrixbotlib, the most direct method is to improve the source code.
1616

1717
# How do I improve the Source Code?
1818

19-
This project follows a variation of the Github Flow workflow. You may find the information located [here](https://guides.github.com/introduction/flow/) to be useful.
19+
This project follows the Github Flow workflow. You may find the information located [here](https://guides.github.com/introduction/flow/) to be useful.
2020

2121
### Ask First
2222

2323
Before you begin, please discuss your planned improvements with a maintainer in our [Matrix Room](https://matrix.to/#/#simplematrixbotlib:matrix.org). This is to make sure that your changes are aligned with the goals of this project, which can help you avoid wasting your time and effort.
24-
25-
### Fork the Repository
26-
27-
Fork the repository by clicking on the "Fork" button.
28-
29-
### Create a Feature Branch
30-
31-
Create a branch specifically for your feature with a descriptive name. Over the course of your development, commit your changes to this branch.
32-
33-
### Keep your Branch up-to-date
34-
35-
While you develop, other branches such as the master branch may receive commits. To make sure that your branch has the latest changes, it is recommended that you rebase your master branch (master) onto the upstream master branch (upstream/master), the rebase your feature branch (example-branch) on your master branch. If you decide to push your changes, it may be necessary to use the --force flag. The process may resemble the following:
36-
37-
```bash
38-
# Commit to your feature branch
39-
git commit -m "example commit"
40-
# Add upstream repository remote
41-
git remote add upstream https://github.com/KrazyKirby99999/simple-matrix-bot-lib.git
42-
# Update your master branch with upstream changes
43-
git fetch && git checkout master
44-
git rebase upstream/master
45-
git push origin master --force
46-
# Update your feature branch with upstream changes
47-
git checkout feature-branch
48-
git rebase master
49-
git push origin feature-branch --force
50-
```
51-
52-
### Create a pull request
53-
54-
When you consider your feature to be ready to merge, create a pull request on [Github](https://github.com/KrazyKirby99999/simple-matrix-bot-lib/compare). Make sure to link to any relevant issues, and provide a description for each commit. If your pull request is considered incomplete, you may be requested to make changes to your feature branch.
55-
56-
###

0 commit comments

Comments
 (0)