Skip to content

Commit 658b7a3

Browse files
committed
Guidelines on how to submit a P.R
1 parent 13ba499 commit 658b7a3

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,13 @@ More stuff coming soon. Stay tuned!
4747

4848
##### Due to several work related commitments, the development rate is a little slow and I apologize for that. However, I'm looking for awesome folks :metal: who could contribute and help me maintain this project.
4949

50+
#### Where can you contribute? (starting from easy to relatively challenging)
51+
52+
- Covering [documentation](https://github.com/booleanhunter/ReactJS-AdminLTE/tree/master/src/components#list-of-components) for all the available components and how to use them (this is the easiest one, but quite important!)
53+
- Converting existing components into ES6/ECMAScript 2016
54+
- Writing tests for components. Similar to tests written in the [React-Bootstrap](https://github.com/react-bootstrap/react-bootstrap/tree/master/test) project.
55+
- Reactifying the rest of the widgets, elements and pages from AdminLTE. Here are the steps to do this:
56+
5057
#### Step 1 :
5158

5259
- Fork or clone this repo. Alternatively - if you have NPM installed, you can also do `npm install adminlte-reactjs`.
@@ -90,4 +97,12 @@ After you've finished writing a component and testing it out, you can include it
9097
- To make sure that your component works correctly, test it out by including it in the page using the library.
9198

9299

100+
#### Some tips before making a pull request
101+
- Make sure that you've pulled the latest commits into your fork.
102+
- Create a branch for your edits - that way the project maintainer can safely pull your code and test it out.
103+
- If it's your first P.R, it'll be easier if you begin with something small first instead of making huge changes in lots of files. It helps me understand what the P.R is about, and I could help you out with the rest of changes if needed. It'll also save you from spending lot of effort in doing something that might not be necessary.
104+
- An important thing to remember is to have a P.R that fixes one issue at a time, and not make changes to lot of files in the same P.R. This way it's easier to test the changes out and have a relatively clean commit log.
105+
- You can learn more about these tips in detail [here](https://guides.github.com/activities/contributing-to-open-source/#contributing)
106+
107+
93108
##### If you have any further queries that you may have on how to contribute, or you have just general questions about how to use the components in your app - feel free to shoot an email. I'll help you out! :smile_cat:

0 commit comments

Comments
 (0)