You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
Thank you for considering contributing to FatPy, a Python package for fatigue life evaluation of materials, part of the FABER project! Your contributions help improve open source tools for fatigue analysis. Start with these steps to make an impact.
4
4
5
-
**[:mag: Learn About FABER](https://vybornak2.github.io/FatPy/faber_cost/)**
5
+
**[:mag: Learn About FABER](https://faberorg.github.io/FatPy/faber_cost/)**
6
6
7
7
## :rocket: Quick Start
8
8
@@ -54,7 +54,7 @@ pip install -e .
54
54
pre-commit install
55
55
```
56
56
57
-
For detailed configuration of your development environment, see the **[Installation Guide :arrow_right:](https://vybornak2.github.io/FatPy/development/install/#installation-guide)**
57
+
For detailed configuration of your development environment, see the **[Installation Guide :arrow_right:](https://faberorg.github.io/FatPy/development/install/#installation-guide)**
58
58
59
59
## :test_tube: Test-Driven Development
60
60
@@ -73,7 +73,7 @@ For detailed configuration of your development environment, see the **[Installat
73
73
6.**Repeat**
74
74
Use the same principles for next feature
75
75
76
-
For more details, see the **[Testing Guide :arrow_right:](https://vybornak2.github.io/FatPy/development/testing/)**
76
+
For more details, see the **[Testing Guide :arrow_right:](https://faberorg.github.io/FatPy/development/testing/)**
77
77
78
78
### Run tests regularly
79
79
@@ -96,7 +96,7 @@ FatPy aims for high code quality utilizing these tools:
96
96
-**MyPy** - Static type checking for reliability.
97
97
-**Pre-commit** - Automated checks before commits.
98
98
99
-
Follow our coding standards for contributions, see **[Code Style Guide :arrow_right:](https://vybornak2.github.io/FatPy/development/code_style/)**
99
+
Follow our coding standards for contributions, see **[Code Style Guide :arrow_right:](https://faberorg.github.io/FatPy/development/code_style/)**
100
100
101
101
### Running Code Quality Checks
102
102
@@ -128,7 +128,7 @@ Add docstrings following Google style to all new code.
128
128
-**Examples**
129
129
Include examples and mathematical formulas where helpful to aid users.
130
130
131
-
Learn best practices and guidelines for documentation, see **[Documentation Guide :arrow_right:](https://vybornak2.github.io/FatPy/development/documentation/)**
131
+
Learn best practices and guidelines for documentation, see **[Documentation Guide :arrow_right:](https://faberorg.github.io/FatPy/development/documentation/)**
132
132
133
133
### Building Documentation
134
134
@@ -159,17 +159,17 @@ Submit a high-quality pull request with these steps:
159
159
160
160
All contributors must follow our standards.
161
161
162
-
Understand our expectations for collaboration, see **[Code of Conduct :arrow_right:](https://github.com/Vybornak2/FatPy/blob/main/CODE_OF_CONDUCT.md)**
162
+
Understand our expectations for collaboration, see **[Code of Conduct :arrow_right:](https://github.com/faberorg/FatPy/blob/main/CODE_OF_CONDUCT.md)**
163
163
164
164
## :bulb: Ideas and Questions
165
165
166
166
Join discussion, create an issue or reach out to maintainers:
0 commit comments