Skip to content

Commit

Permalink
Merge pull request #294 from Ansh101112/PNF
Browse files Browse the repository at this point in the history
Contributing Guidlines updated
  • Loading branch information
usha-madithati authored Jun 17, 2024
2 parents 763a88a + df02cc8 commit 6c3261f
Showing 1 changed file with 55 additions and 25 deletions.
80 changes: 55 additions & 25 deletions Contribution.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,56 @@
->Getting Started

->Contributing Contributions are always welcome!

->Fork this repository.

->Clone your forked copy of the project. git clone htpps://github.com/your-username/jobproject.git

->Add reference to original repository,use the following command git remote add upstream htpps://github.com/your-username/jobproject.git

->Check the remotes for this repository,use following command. git remote -v

->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

->Create a new branch. git checkout -b <your_branch_name>

->You are all set ! Perfom your desired changes to the code base.

->Track your changes. git add .

->Commit your changes. git commit -m "relevant commit message"

->Push the committed changes in your feature branch to your remote repo. git push -u origin <your_branch_name>

->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.
## Contributing Guidelines

### Getting Started

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).

### Contributing

Contributions are always welcome! Here's a step-by-step guide on how to contribute:

1. **Fork** this repository to your GitHub account.

2. **Clone** your forked copy of the project to your local machine:

```bash
git clone https://github.com/your-username/jobproject.git
3. Add a remote reference to the original repository:
```bash
git remote add upstream https://github.com/usha-madithati/esmart.github.io
```
4. Verify the upstream and origin remotes are correctly set:
``` bash
git remote -v
```
5. Sync your fork with the original repository to ensure you are up-to-date:
```bash
git pull upstream main
```
6. Create a new branch for your feature or bug fix:
```bash
git checkout -b <your-branch-name>
```
7. Make your desired changes to the code base. Ensure your changes adhere to our coding standards.
8. Track your changes:
```bash
git add .
```
9. Commit your changes with a clear and concise commit message:
```bash
git commit -m "Your relevant commit message here"
```
10. Push your committed changes to your remote branch on GitHub:
```bash
git push -u origin <your-branch-name>
```
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.

-> Ensure your PR compares your feature branch with the appropriate branch in the original repository.
-> Provide a clear description of your changes in the PR, including any related issue numbers if applicable.

12. Congratulations! You've successfully made your contribution to our project. Thank you!
```bash
This Markdown file provides all the necessary steps in a clear and structured format, ensuring new contributors can easily follow along and make their
contributions to the project. Adjust the placeholders (like links and branch names) based on your specific project details.
```

0 comments on commit 6c3261f

Please sign in to comment.