Skip to content

Commit f36fdcf

Browse files
committed
CONTRIBUTING.md File Add
1 parent e64b90d commit f36fdcf

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

CONTRIBUTING.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing to JavaScript-KBC
2+
3+
Welcome to JavaScript-KBC! We're thrilled that you're interested in contributing to this CLI-based JavaScript game. By contributing, you can help make the game better for everyone and potentially learn more about JavaScript along the way.
4+
5+
## How to Contribute
6+
7+
1. Fork the Repository: Start by forking the [JavaScript-KBC GitHub repository](https://github.com/pb2204/JavaScript-KBC) to your own GitHub account. Click the "Fork" button on the top right of the repository page.
8+
9+
2. Clone the Repository: Clone your forked repository to your local machine using `git clone`:
10+
11+
```bash
12+
git clone https://github.com/pb2204/JavaScript-KBC.git
13+
```
14+
15+
3. Create a Branch: Create a new branch for your contributions. This helps keep your changes isolated:
16+
17+
```bash
18+
git checkout -b my-feature
19+
```
20+
21+
4. Make Changes: Make your desired changes or improvements to the codebase. Feel free to add new features, fix bugs, or improve documentation.
22+
23+
5. Test Your Changes: Before submitting a pull request, make sure to test your changes thoroughly to ensure they work as expected.
24+
25+
6. Commit Your Changes: Commit your changes with a clear and concise commit message:
26+
27+
```bash
28+
git commit -m "Add my awesome feature"
29+
```
30+
31+
7. Push to Your Fork: Push your changes to your forked repository on GitHub:
32+
33+
```bash
34+
git push origin my-feature
35+
```
36+
37+
8. Create a Pull Request: Go to the [JavaScript-KBC GitHub repository](https://github.com/pb2204/JavaScript-KBC) and click on the "New Pull Request" button. Compare and create a pull request from your branch to the main repository.
38+
39+
9. Describe Your Changes: Provide a clear and detailed description of the changes you've made in your pull request. Explain why these changes are necessary and how they benefit the project.
40+
41+
10. Review and Collaboration: After submitting your pull request, other contributors or maintainers may review your changes, suggest improvements, or discuss potential modifications. Be open to collaboration and constructive feedback.
42+
43+
11. Continuous Integration: Your pull request may be subject to automated tests and checks. Ensure that all tests pass and address any issues that may arise.
44+
45+
12. Merge: Once your pull request is approved and passes all checks, it will be merged into the main project. Congratulations, you've successfully contributed to JavaScript-KBC!
46+
47+
## Code of Conduct
48+
49+
Please note that JavaScript-KBC follows the [Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you are expected to uphold this code. If you encounter any behavior that violates the code, please report it.
50+
51+
## Issues and Bug Reports
52+
53+
If you discover bugs or have ideas for improvements, please open an issue on the GitHub repository. We welcome bug reports and feedback from the community.
54+
55+
Thank you for your interest in contributing to JavaScript-KBC. Your contributions are valued and appreciated!

0 commit comments

Comments
 (0)