|
1 |
| -->Getting Started |
2 |
| - |
3 |
| -->Contributing Contributions are always welcome! |
4 |
| - |
5 |
| -->Fork this repository. |
6 |
| - |
7 |
| -->Clone your forked copy of the project. git clone htpps://github.com/your-username/jobproject.git |
8 |
| - |
9 |
| -->Add reference to original repository,use the following command git remote add upstream htpps://github.com/your-username/jobproject.git |
10 |
| - |
11 |
| -->Check the remotes for this repository,use following command. git remote -v |
12 |
| - |
13 |
| -->Always take a pull from the upstream repository to your main branch to keep it up-to-date with the main git pull upstream main |
14 |
| - |
15 |
| -->Create a new branch. git checkout -b <your_branch_name> |
16 |
| - |
17 |
| -->You are all set ! Perfom your desired changes to the code base. |
18 |
| - |
19 |
| -->Track your changes. git add . |
20 |
| - |
21 |
| -->Commit your changes. git commit -m "relevant commit message" |
22 |
| - |
23 |
| -->Push the committed changes in your feature branch to your remote repo. git push -u origin <your_branch_name> |
24 |
| - |
25 |
| -->To create a pull request, click on "Compare and pull requests". Please ensure you compare your feature branch to the desired branch of the repo you are suppose to make a PR to. |
| 1 | +## Contributing Guidelines |
| 2 | + |
| 3 | +### Getting Started |
| 4 | + |
| 5 | +Thank you for considering contributing to our project! Before you get started, please make sure you have read and understood our [Code of Conduct](link-to-code-of-conduct) and [License](link-to-license). |
| 6 | + |
| 7 | +### Contributing |
| 8 | + |
| 9 | +Contributions are always welcome! Here's a step-by-step guide on how to contribute: |
| 10 | + |
| 11 | +1. **Fork** this repository to your GitHub account. |
| 12 | + |
| 13 | +2. **Clone** your forked copy of the project to your local machine: |
| 14 | + |
| 15 | + ```bash |
| 16 | + git clone https://github.com/your-username/jobproject.git |
| 17 | +3. Add a remote reference to the original repository: |
| 18 | + ```bash |
| 19 | + git remote add upstream https://github.com/usha-madithati/esmart.github.io |
| 20 | + ``` |
| 21 | +4. Verify the upstream and origin remotes are correctly set: |
| 22 | + ``` bash |
| 23 | + git remote -v |
| 24 | + ``` |
| 25 | +5. Sync your fork with the original repository to ensure you are up-to-date: |
| 26 | + ```bash |
| 27 | + git pull upstream main |
| 28 | + ``` |
| 29 | +6. Create a new branch for your feature or bug fix: |
| 30 | + ```bash |
| 31 | + git checkout -b <your-branch-name> |
| 32 | + ``` |
| 33 | +7. Make your desired changes to the code base. Ensure your changes adhere to our coding standards. |
| 34 | +8. Track your changes: |
| 35 | + ```bash |
| 36 | + git add . |
| 37 | + ``` |
| 38 | +9. Commit your changes with a clear and concise commit message: |
| 39 | + ```bash |
| 40 | + git commit -m "Your relevant commit message here" |
| 41 | + ``` |
| 42 | +10. Push your committed changes to your remote branch on GitHub: |
| 43 | + ```bash |
| 44 | + git push -u origin <your-branch-name> |
| 45 | + ``` |
| 46 | +11. Submit a Pull Request (PR) by navigating to the repository on GitHub where you forked the project. Click on "Compare & pull request" to start the process. |
| 47 | + |
| 48 | + -> Ensure your PR compares your feature branch with the appropriate branch in the original repository. |
| 49 | + -> Provide a clear description of your changes in the PR, including any related issue numbers if applicable. |
| 50 | + |
| 51 | +12. Congratulations! You've successfully made your contribution to our project. Thank you! |
| 52 | + ```bash |
| 53 | + This Markdown file provides all the necessary steps in a clear and structured format, ensuring new contributors can easily follow along and make their |
| 54 | + contributions to the project. Adjust the placeholders (like links and branch names) based on your specific project details. |
| 55 | + ``` |
26 | 56 |
|
0 commit comments