Skip to content

Commit 27ede13

Browse files
committed
fixed findings
broken readme links, removed .md from contributing, moved pr template
1 parent b07ac97 commit 27ede13

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Contributing Guideline - Internal Repository
1+
# Contributing Guideline
22
As an open-source project, we welcome and encourage the community to submit patches directly to the project.
33
In our collaborative open-source environment, standards and methods for submitting changes help reduce
44
the chaos that can result from an active development community.
File renamed without changes.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
** TODO ** Put project introduction here. 1-2 sentence about the project.
33
## How to use the template
44
1. Import the [basic ruleset](https://github.com/SiliconLabsSoftware/devs-template/blob/main/.github/rulesets/Silabs-basic-public-ruleset.json). Follow the official GitHub [guide](https://docs.github.com/en/enterprise-cloud@latest/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#importing-a-ruleset).
5-
2. Update if necessary the [issue_templates](.github/ISSUE_TEMPLATE/) and the [pull request template](./PULL_REQUEST_TEMPLATE.md)
5+
2. Update if necessary the [issue_templates](.github/ISSUE_TEMPLATE/) and the [pull request template](./.github/PULL_REQUEST_TEMPLATE.md)
66
3. Create your sw projects under [projects/](projects/) folder.
77
4. Check [.gitignore](.gitignore) file and modify it if it is necessary
88
5. Check the [./Dockerfile](./Dockerfile) and extend it if necessary
@@ -47,7 +47,7 @@ Using Docker for the build environment has several advantages:
4747
To set up the Docker-based build environment, follow these steps:
4848
1. Install Docker on your machine. Only Linux and MacOS platforms are supported for now.
4949
2. Clone the repository.
50-
3. Build the Docker image using the provided [Dockerfile](./.github/Dockerfile).
50+
3. Build the Docker image using the provided [Dockerfile](./Dockerfile).
5151
4. Run the Docker container with the necessary configurations.
5252

5353
### Windows
@@ -63,7 +63,7 @@ To set up the Docker-based build environment, follow these steps:
6363
**TODO**
6464
Explain how can a developer debug this software project. Pictures are recommended.
6565
## Contributing
66-
Please follow the [CONTRIBUTING](./.github/CONTRIBUTING.md) guideline.
66+
Please follow the [CONTRIBUTING](./.github/CONTRIBUTING) guideline.
6767

6868
## License
6969
See the [LICENSE.md](./LICENSE.md) file for details.

0 commit comments

Comments
 (0)