Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Created CONTRIBUTING.md #13

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Created CONTRIBUTING.md #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 1,92 @@
# Contributing to Data Augmentation Review

Welcome to the Data Augmentation Review repository. Your contributions are valued and play a vital role in advancing our understanding of data augmentation techniques. To ensure a smooth and collaborative experience, we've outlined our contribution guidelines below.

## **Submitting Contributions**

The process for submitting contributions is as follows:

### **1. Choose or Create an Issue**

- Begin by reviewing the existing issues to identify a task that aligns with your expertise or interests.
- If you can't find a suitable issue, consider creating a new one. When creating an issue, please provide a detailed description and context for better clarity.

### **2. Fork the Repository**

- To initiate your contribution, fork the main repository by clicking the "Fork" button. This will create a copy of the repository in your personal GitHub account.

### **3. Clone Your Forked Repository**

- Clone your forked repository to your local development environment using the following command:

```bash
git clone https://github.com/your-username/data-augmentation-review.git
```

### **4. Set Up the Upstream Remote**

- Keep a reference to the original project by adding it as the upstream remote:

```bash
cd data-augmentation-review
git remote add upstream https://github.com/AgaMiko/data-augmentation-review
git remote -v
```

### **5. Create a New Branch**

- Before you start working on a contribution, create a new branch for your specific task:

```bash
git checkout -b my-contribution
```

## **Working on Your Contribution**

Once you've set up your development environment and created a new branch, you can start working on your contribution. Be sure to follow these steps:

### **6. Make Changes**

- Make the necessary changes, additions, or improvements in your local repository. Adhere to coding conventions, and ensure your code is well-documented and properly formatted.

### **7. Commit Your Changes**

- Commit your changes with clear, descriptive commit messages to facilitate the review process:

```bash
git commit -m "Add descriptive message here"
```

### **8. Push Your Changes**

- Push the committed changes to your remote repository on GitHub:

```bash
git push origin my-contribution
```

### **9. Create a Pull Request**

- Visit your repository on GitHub and click the "New Pull Request" button to create a pull request from your branch to the main repository.

### **10. Await Review**

- Your pull request will undergo review, and feedback will be provided by the maintainers or contributors. Be prepared to address any suggested changes.

## **Community Involvement**

While contributing, consider the following ways to engage with the community:

### **11. Join Discussions**

- Engage with the community by participating in discussions related to data augmentation techniques and their applications.

### **12. Share Ideas**

- If you have innovative ideas or suggestions for the project, feel free to open an issue to initiate a constructive conversation.

## **Acknowledgment**

We greatly appreciate your willingness to contribute to the Data Augmentation Review project. Your involvement will help advance the field and promote knowledge sharing. If you have any questions or require assistance, please don't hesitate to reach out to the maintainers.

Thank you for contributing to this repo! 🚀