Skip to content

Commit ec5fd0f

Browse files
committed
fix: move CONTRIBUTING back to docs/ folder so github detects it
1 parent b740fcd commit ec5fd0f

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ git clone https://github.com/AntonioMrtz/SpotifyElectron.git
5252
## 🖐 How to Contribute to the project
5353

5454
Are you interested in contributing to the project? Check our contributing rules and methodologies in
55-
[CONTRIBUTING readme](docs/developer/CONTRIBUTING.md). Also you can check [all the contributors](docs/CONTRIBUTORS.md) to the project.
55+
[CONTRIBUTING readme](docs/CONTRIBUTING.md). Also you can check [all the contributors](docs/CONTRIBUTORS.md) to the project.
5656

5757
## 🎯 Project's goals
5858

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 🖐️ How to contribute
22

3-
In this document we will cover how contribute to the project and the rules associated to the process. We gladly accept all kinds of contributions, from writing new features and fixing bugs to improve the existing documentation. When contributing to the project the [code of conduct](../CODE_OF_CONDUCT.md) must be followed.
3+
In this document we will cover how contribute to the project and the rules associated to the process. We gladly accept all kinds of contributions, from writing new features and fixing bugs to improve the existing documentation. When contributing to the project the [code of conduct](CODE_OF_CONDUCT.md) must be followed.
44

55
We welcome any help you can offer and are eagerly waiting for your contributions.
66
Feel free to ask for assistance or guidance at any time. We encourage you to get involved because contributing to open source projects allows you to collaborate with other members,
@@ -9,17 +9,17 @@ improve your coding skills, and enhance your communication abilities.
99
## 🖐️ Steps to Contribute
1010

1111
1. Select an [issue](https://github.com/AntonioMrtz/SpotifyElectron/issues) and **ask to work on it by leaving a comment in the issue page(Not in Trello)**.
12-
2. Create a new branch with the feature you're implementing using the [branch naming convention](Git-Convention.md).
13-
3. Push your changes to the new branch using the [commit naming convention](Git-Convention.md).
12+
2. Create a new branch with the feature you're implementing using the [branch naming convention](developer/Git-Convention.md).
13+
3. Push your changes to the new branch using the [commit naming convention](developer/Git-Convention.md).
1414
4. Add tests for every functionality changed or added.
15-
5. Go to your branch in Github, then select Pull Request and fill the fields indicated in the template. Remember to rename the Pull Request using our [convention](Git-Convention.md).
15+
5. Go to your branch in Github, then select Pull Request and fill the fields indicated in the template. Remember to rename the Pull Request using our [convention](developer/Git-Convention.md).
1616

1717
_It's important to leave a comment about working on an issue so the maintainer can add you as an assignee and avoid two people working on the same issue_.
1818

1919
_Trello links are used to synchronize Github issues with board tasks, we're not accepting new members due to free tier limitation until you have contributed at least twice_.
2020
## 🙍‍♂️ Contributors list
2121

22-
Once you contribute to the project, your name and GitHub profile will be added into the [CONTRIBUTORS list](../CONTRIBUTORS.md) as an acknowledgement for your work and in order to thank you.
22+
Once you contribute to the project, your name and GitHub profile will be added into the [CONTRIBUTORS list](CONTRIBUTORS.md) as an acknowledgement for your work and in order to thank you.
2323

2424
## 📦 Required Software
2525

@@ -30,5 +30,5 @@ Once you contribute to the project, your name and GitHub profile will be added i
3030

3131
## ⚙ Set up development environment
3232

33-
- [Backend](backend/SETUP.md)
34-
- [Frontend](frontend/SETUP.md)
33+
- [Backend](developer/backend/SETUP.md)
34+
- [Frontend](developer/frontend/SETUP.md)

docs/CONTRIBUTORS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,4 +111,4 @@ We're currently looking for contributions for the following:
111111
- Improve the project
112112
- Docs Writing
113113

114-
For more information, please refer to our [CONTRIBUTING guide](developer/CONTRIBUTING.md).
114+
For more information, please refer to our [CONTRIBUTING guide](CONTRIBUTING.md).

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ remote_branch: gh-pages
77
nav:
88
- Home: index.md
99
- Project Vision: VISION.md
10+
- How to contribute: CONTRIBUTING.md
1011
- Developer guides:
11-
- How to contribute: developer/CONTRIBUTING.md
1212
- Git convention: developer/Git-Convention.md
1313
- Architecture: developer/Architecture.md
1414
- Global Set up: developer/SETUP.md

0 commit comments

Comments
 (0)