Skip to content

Commit aba2855

Browse files
authored
Create CONTRIBUTING.md
1 parent 708ea33 commit aba2855

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

CONTRIBUTING.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# LTC - Contributors' Guide
2+
3+
Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on Readme.md.
4+
5+
6+
## Getting started
7+
8+
This project does not need any particular code writing skills however you should be familiar with Linux commands.
9+
10+
### Issues
11+
12+
**Create a new issue**
13+
- If you spot a problem with any existing command in the [Readme](https://github.com/SaniTheWay/LearnBase-LinuxTerminalCommands/readme) doc, search if an [issue](https://github.com/SaniTheWay/LearnBase-LinuxTerminalCommands/issues) already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
14+
15+
**Solve an issue**
16+
- Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information.
17+
18+
### To make Changes
19+
20+
- Fork the repository.
21+
- Create a working branch and start with your changes!
22+
- Commit the changes once done.
23+
24+
## Pull Request
25+
26+
When you're done making the changes, open a pull request, often referred to as a PR.
27+
28+
- Fill out the *"Ready for review"* template so we can review your PR. The template helps reviewers understand your changes and the purpose of your pull request.
29+
- Don't forget to link PR to issue if you are *solving* one.
30+
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR we will review it.
31+
- We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
32+
- As you update your PR and apply changes, mark each conversation as resolved.
33+
- If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.
34+
35+
## Your PR is merged!
36+
Congrats 🎉🎉
37+
Once your PR is merged, your contributions will be publicly visible. :sparkles:
38+
39+
---
40+
Looking for your contribution.

0 commit comments

Comments
 (0)