|
| 1 | + # Contributing to Python Programming Basics for Artificial Inteligence : |
| 2 | + |
| 3 | +We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: |
| 4 | + |
| 5 | +- Reporting a bug |
| 6 | +- Discussing the current state of the code |
| 7 | +- Submitting a fix |
| 8 | +- Proposing new features |
| 9 | +- Becoming a maintainer |
| 10 | + |
| 11 | +## Steps to contribute |
| 12 | + |
| 13 | +- Comment on the issue you want to work on. Make sure it's not assigned to someone else. |
| 14 | + |
| 15 | +### Making a PR |
| 16 | + |
| 17 | +> - Make sure you have been assigned the issue to which you are making a PR. |
| 18 | +> - If you make PR before being assigned, It may be labeled `invalid` and closed without merging. |
| 19 | +
|
| 20 | +- Fork the repo and clone it on your machine. |
| 21 | +- Add a upstream link to main branch in your cloned repo |
| 22 | + |
| 23 | + ```sh |
| 24 | + git remote add upstream https://github.com/EimanTahir027/Python-Programming-Basics-For-Artificial-Intelligence.git |
| 25 | + ``` |
| 26 | + |
| 27 | +- Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes) |
| 28 | + |
| 29 | + ```sh |
| 30 | + git pull upstream dev |
| 31 | + ``` |
| 32 | + |
| 33 | +- Create your feature branch |
| 34 | + |
| 35 | + ```sh |
| 36 | + git checkout -b <feature-name> |
| 37 | + ``` |
| 38 | + |
| 39 | +- Include the changes you have made for commits |
| 40 | + |
| 41 | + ```sh |
| 42 | + git add <name-of-file> |
| 43 | + ``` |
| 44 | + |
| 45 | +- Commit all the changes |
| 46 | + |
| 47 | + ```sh |
| 48 | + git commit -m "Meaningful commit message" |
| 49 | + ``` |
| 50 | + |
| 51 | +- Push the changes for review |
| 52 | + |
| 53 | + ```sh |
| 54 | + git push origin <branch-name> |
| 55 | + ``` |
| 56 | + |
| 57 | +- Create a PR from our repo on Github. |
| 58 | + |
| 59 | +### Additional Notes |
| 60 | + |
| 61 | +- Any changes should be made in the `dev` branch. |
| 62 | +- Changes should be logged in the `CHANGELOG.md` file. |
| 63 | +- Code should be properly commented to ensure it's readability. |
| 64 | +- If you've added code that should be tested, add tests as comments. |
| 65 | +- Make sure your code properly formatted. |
| 66 | +- Issue that pull request! |
| 67 | + |
| 68 | +## Issue suggestions/Bug reporting |
| 69 | + |
| 70 | +When you are creating an issue, make sure it's not already present. Furthermore, provide a proper description of the changes. If you are suggesting any code improvements, provide through details about the improvements. |
| 71 | +
|
| 72 | +**Great Issue suggestions** tend to have: |
| 73 | +
|
| 74 | +- A quick summary of the changes. |
| 75 | +- In case of any bug provide steps to reproduce |
| 76 | + - Be specific! |
| 77 | + - Give sample code if you can. |
| 78 | + - What you expected would happen |
| 79 | + - What actually happens |
| 80 | + - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) |
| 81 | + |
| 82 | + |
| 83 | +## License |
| 84 | + |
| 85 | +By contributing, you agree that your contributions will be licensed under its [MIT License](http://choosealicense.com/licenses/mit/). |
0 commit comments