Skip to content

Commit 39b8395

Browse files
committed
cotribution md change
1 parent 1b6edab commit 39b8395

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

CONTRIBUTING.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,70 @@
1+
## Contributing to this Repository
2+
Welcome ! We greatly appreciate your interest in contributing to our project. Please follow the guidelines below to ensure a smooth and successful contribution process.
3+
4+
## Fork the Repository
5+
To get started, fork the dstoolkit-text2sql-and-imageprocessing
6+
main repository to your own GitHub account by clicking on the "Fork" button at the top right corner of the repository page. This will create a copy of the repository under your account, which you can freely make changes to.
7+
8+
## Clone the Repository
9+
Next, clone the forked repository to your local machine using the following command:
10+
11+
```
12+
git clone https://github.com/[your-github-username]/[your-repository-name].git
13+
```
14+
15+
Make sure to replace [your-github-username] with your actual GitHub username and [your-repository-name] with the name of your forked repository.
16+
17+
## Set Up Access to Relevant Services
18+
Please ensure that you have the appropriate permissions and credentials to avoid any issues during the contribution process. This includes Azure DevOps project, repository, pipelines and Azure Subscription. If your contribution requires access to Azure Machine Learning compute, make sure you have the necessary permissions and access before proceeding with your changes.
19+
20+
## Install Dependencies and Validate Environment
21+
Before making changes, ensure that you have installed all the dependencies required for the project. This include Conda, Python 3.8 (ideal), azureml sdk v2 and tools. Validate that your development environment is set up correctly and meets the project's requirements.
22+
23+
## Create a Branch
24+
Create a new branch for your contribution. It's important to create a new branch for each contribution to keep the main branch clean and stable. You can create a new branch using the following command:
25+
```
26+
git checkout -b [branch-name]
27+
```
28+
29+
Replace [branch-name] with a descriptive name for your branch that indicates the purpose of your contribution.
30+
31+
## Make Changes
32+
Now it's time to make your changes! Follow the coding style and guidelines of the project, and thoroughly test your changes in your local environment. Ensure that your changes do not introduce any errors or break the existing functionality. Be sure to add appropriate comments and documentation as needed.
33+
34+
## Validate code changes
35+
Before submitting your contribution, it's crucial to validate your changes by building and testing the project on your environment. This includes running code quality checks, linting, unit tests, MLOps CI/CD and AzureML pipelines including training scripts, executing tests, or other validation processes. Make sure that your changes do not cause any build failures or test errors.
36+
37+
## Commit and Push Changes
38+
Once you're confident with your changes, commit your changes and push them to your forked repository using the following commands:
39+
40+
```
41+
git add .
42+
git commit -m "Your commit message here"
43+
git push origin [branch-name]
44+
```
45+
Replace [branch-name] with the name of your branch.
46+
47+
## Create a Pull Request
48+
Go to the original [Your Repository Name] repository on GitHub and click on the "New Pull Request" button. Select your branch from the base and compare branches drop-down menus. Review your changes and provide a descriptive title and detailed description for your pull request. Include relevant information, such as the purpose of your contribution, the changes made, and any necessary context. Click on the "Create Pull Request" button to submit your contribution.
49+
50+
## Validate Builds and Tests
51+
After PR is created, build validation must pass before the code can be merged on the target develop branch. Any feedback from build validation must be addressed or else the PR will not get merged to target develop branch.
52+
53+
## Review and Address Feedback
54+
Your pull request will be reviewed by the repository maintainers, and they may provide feedback or request changes. Be sure to monitor your pull request and address any feedback in a timely manner. This may involve making additional changes, providing clarification, or addressing any issues raised during the review process.
55+
56+
## Follow Code of Conduct
57+
As a contributor, it's important to adhere to the project's code of conduct. Make sure to follow the project's guidelines, respect the contributions of others, and avoid any inappropriate behavior. Additionally, ensure that your contribution does not violate any copyright or intellectual property rights.
58+
59+
## Merge and Close
60+
Once your contribution has been approved and all feedback has been addressed, you should merge your changes into the develop branch. After the changes have been merged, your contribution will be credited and acknowledged in the project's documentation or contributors list. Your pull request will then be closed, and your contribution will become part of the project's codebase.
61+
62+
Congratulations! You have successfully contributed to dstoolkit-text2sql-and-imageprocessing. Thank you for your valuable contribution and for following the contribution guidelines.
63+
64+
If you have any questions or need further assistance, feel free to reach out to the repository maintainers or the project's team channel for support.
65+
66+
Happy contributing!
67+
168
## Contributing
269

370
This project welcomes contributions and suggestions. Most contributions require you to agree to a

0 commit comments

Comments
 (0)