Skip to content

Commit c93336a

Browse files
authored
Update README.md
1 parent f57efb1 commit c93336a

File tree

1 file changed

+47
-1
lines changed

1 file changed

+47
-1
lines changed

README.md

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ def example_function(param1: int, param2: str) -> bool:
4545
```
4646

4747

48-
### Push to remote
48+
### Contributing via git push to remote
4949

5050
Commit and push the changes:
5151
```bash
@@ -58,6 +58,52 @@ Once you push, the documentation will be automatically refreshed in about one mi
5858
If you need to rebuild the documentation locally or set up the Github workflow from scratch, please refer to [Setup_Documentation_And_Deployment.md](Setup_Documentation_And_Deployment.md).
5959

6060

61+
### Contributing via pull requests
62+
63+
We welcome contributions from the community! If you'd like to contribute to this project, please follow these steps:
64+
65+
1. **Fork the Repository**
66+
67+
Click the "Fork" button at the top right of this repository's page on GitHub to create your own copy.
68+
69+
2. **Clone Your Fork**
70+
71+
Clone your forked repository to your local machine:
72+
```bash
73+
git clone https://github.com/your-username/repository-name.git
74+
cd repository-name
75+
```
76+
77+
3. Create a New Branch Create a new branch for your changes:
78+
79+
```bash
80+
git checkout -b feature/your-feature-name
81+
```
82+
83+
4. Commit Your Changes
84+
```bash
85+
git add .
86+
git commit -m "Add feature: brief description of your changes"
87+
```
88+
89+
5. Push to Your Fork
90+
```bash
91+
git push origin feature/your-feature-name
92+
```
93+
94+
6. Create a Pull Request
95+
96+
- Go to the original repo on GitHub
97+
- Click on "Pull requests" and then the "New pull request" button
98+
- Choose your fork and the branch you created
99+
- Click "Create pull request"
100+
- Provide a title and description for your pull request
101+
102+
7. Wait for Review The project maintainers will review your pull request. They may ask for changes or clarifications.
103+
104+
8. Once approved, a project maintainer will merge your pull request.
105+
106+
61107
## Summary of Recent Papers on Multi-Objective Alignment
62108
For convenience, we also list of recent papers focused on multi-objective alignment. While this list is not exhaustive, we encourage contributions to enrich it further. Feel free to add any relevant papers or resources that you believe would benefit the community.
63109

0 commit comments

Comments
 (0)