|
1 | 1 | # Contributing to atomate2
|
2 | 2 |
|
3 |
| -We love your input! We want to make contributing to as easy and |
| 3 | +We love your input! We want to make contributing as easy and |
4 | 4 | transparent as possible, whether it's:
|
5 | 5 |
|
6 | 6 | - Reporting a bug
|
@@ -32,20 +32,20 @@ make quick and meaningful fixes. When we confirm your bug report,
|
32 | 32 | we'll move it to the GitHub issues where its progress can be
|
33 | 33 | further tracked.
|
34 | 34 |
|
35 |
| -## Contributing code modifications or additions through Github |
| 35 | +## Contributing code modifications or additions through GitHub |
36 | 36 |
|
37 |
| -We use github to host code, to track issues and feature requests, |
| 37 | +We use GitHub to host code, to track issues and feature requests, |
38 | 38 | as well as accept pull requests. We maintain a list of all
|
39 | 39 | contributors [here](https://materialsproject.github.io/atomate2/contributors.html).
|
40 | 40 |
|
41 | 41 | Pull requests are the best way to propose changes to the codebase.
|
42 |
| -Follow the [Github flow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow) |
| 42 | +Follow the [GitHub flow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow) |
43 | 43 | for more information on this procedure.
|
44 | 44 |
|
45 | 45 | The basic procedure for making a PR is:
|
46 | 46 |
|
47 | 47 | - Fork the repo and create your branch from master.
|
48 |
| -- Commit your improvements to your branch and push to your Github fork (repo). |
| 48 | +- Commit your improvements to your branch and push to your GitHub fork (repo). |
49 | 49 | - When you're finished, go to your fork and make a Pull Request. It will
|
50 | 50 | automatically update if you need to make further changes.
|
51 | 51 |
|
|
0 commit comments