Skip to content

Commit b419174

Browse files
committed
updating CONTRIBUTING.md
1 parent a1f302e commit b419174

4 files changed

Lines changed: 93 additions & 82 deletions

File tree

CONTRIBUTING.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# I want to contribute! What should i do?
2+
3+
Thats awesome! There are many ways you can contribute to the Feliz project:
4+
5+
1. 🏷️ Start by creating an issue of your planned changes. This allows us to discuss the changes before you start working on them and ensure that they are aligned with the project goals.
6+
2. 🛠️ Fork the repository and create a new branch for your changes.
7+
- Check out the section below to find the most important instructions for setting up your development environment.
8+
3. ✨ Make your changes and ensure that you follow the coding style and conventions used in the project. (Styling should be automatically applied by Fantomas if you use VS Code with Ionide)
9+
4. ✅ Write tests for your changes to ensure that they work as expected and do not introduce any regressions.
10+
5. 📚 Document your changes!
11+
- Every Feliz-.fsproj has a related "CHANGELOG" file. Add your changes following the instructions inside the file!
12+
13+
Please use the following base structure for your changelog entries:
14+
15+
`<the-cool-and-awesome-changes-you-did> <#any-related-issue-or-pr-number> (by <@your-github-username>)`
16+
17+
- Write/Update documentation under `./docs`!
18+
6. 📄 Create a pull request with a clear description of your changes and the issue it addresses.
19+
20+
---
21+
22+
# Setting up your development environment
23+
24+
## Requirements
25+
26+
1. [.NET SDK 8.0 or later](https://dotnet.microsoft.com/en-us/download)
27+
2. [Node.js 20 or later](https://nodejs.org/)
28+
29+
## Setup
30+
31+
1. Clone the repository
32+
2. Install dependencies: `dotnet run --project ./build/Build.fsproj setup`.
33+
34+
<details>
35+
36+
<summary>Alternatively, you can manually install the dependencies:</summary>
37+
38+
- NPM dependencies:
39+
40+
```bash
41+
npm install
42+
```
43+
44+
- .NET dependencies:
45+
46+
```bash
47+
dotnet restore
48+
```
49+
50+
- .NET tools:
51+
52+
```bash
53+
dotnet tool restore
54+
```
55+
56+
</details>
57+
58+
3. Verify correct setup by running the tests `dotnet run --project ./build/Build.fsproj test`
59+
4. Ready! 🎉
60+
61+
62+
# Workflows
63+
64+
Feliz uses a f# build project to run common tasks such as testing. You can find the entrypoint for the build project under `./build/Build.fsproj`.
65+
66+
:::info
67+
- **On Windows** you can also use `.\build.cmd` to run the build tasks instead of `dotnet run --project ./build/Build.fsproj`.
68+
- **On MacOS/Linux** you can also use `./build.sh` to run the build tasks instead of `dotnet run --project ./build/Build.fsproj`.
69+
:::
70+
71+
## Testing
72+
73+
```bash
74+
dotnet run --project ./build/Build.fsproj test
75+
```
76+
77+
## Run docs
78+
79+
1. Go into docs folder:
80+
81+
```bash
82+
cd docs
83+
```
84+
85+
2. Start docs server:
86+
87+
```bash
88+
npm run start
89+
```
File renamed without changes.

docs/docs/api-docs/Contributing.md

Lines changed: 3 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -5,89 +5,11 @@ sidebar_position: 10
55

66
# Contributing
77

8-
If you are enjoying the Feliz project, consider contributing back and helping out with the community. There are many ways you can contribute, the first of which is to simply use Feliz in your project and report issues you come across whether there are missing style properties or properties that were incorrectly implemeneted.
8+
**We need your help!** We actually do! Feliz is an open-source project and thrives thanks to the contributions from the community. Whether it's fixing bugs, adding new features, improving documentation, or suggesting ideas, we need your help to make Feliz even better.
99

10-
# I want to contribute! What should i do?
10+
Do not shy away from contributing just because you think you are "not experienced enough".
1111

12-
Thats awesome! There are many ways you can contribute to the Feliz project:
12+
Check out the [CONTRIBUTING.md](https://github.com/fable-hub/Feliz/blob/master/CONTRIBUTING.md) file in the repository and get in contact with us via the issues ❤️!
1313

14-
1. 🏷️ Start by creating an issue of your planned changes. This allows us to discuss the changes before you start working on them and ensure that they are aligned with the project goals.
15-
2. 🛠️ Fork the repository and create a new branch for your changes.
16-
- Check out the section below to find the most important instructions for setting up your development environment.
17-
3. ✨ Make your changes and ensure that you follow the coding style and conventions used in the project. (Styling should be automatically applied by Fantomas if you use VS Code with Ionide)
18-
4. ✅ Write tests for your changes to ensure that they work as expected and do not introduce any regressions.
19-
5. 📚 Document your changes!
20-
- Every Feliz-.fsproj has a related "CHANGELOG" file. Add your changes following the instructions inside the file!
21-
- Write/Update documentation under `./docs`!
22-
6. 📄 Create a pull request with a clear description of your changes and the issue it addresses.
2314

24-
---
25-
26-
# Setting up your development environment
27-
28-
## Requirements
29-
30-
1. [.NET SDK 8.0 or later](https://dotnet.microsoft.com/en-us/download)
31-
2. [Node.js 20 or later](https://nodejs.org/)
32-
33-
## Setup
34-
35-
1. Clone the repository
36-
2. Install dependencies: `dotnet run --project ./build/Build.fsproj setup`.
37-
38-
<details>
39-
40-
<summary>Alternatively, you can manually install the dependencies:</summary>
41-
42-
- NPM dependencies:
43-
44-
```bash
45-
npm install
46-
```
47-
48-
- .NET dependencies:
49-
50-
```bash
51-
dotnet restore
52-
```
53-
54-
- .NET tools:
55-
56-
```bash
57-
dotnet tool restore
58-
```
59-
60-
</details>
61-
62-
3. Verify correct setup by running the tests `dotnet run --project ./build/Build.fsproj test`
63-
4. Ready! 🎉
64-
65-
66-
# Workflows
67-
68-
Feliz uses a f# build project to run common tasks such as testing. You can find the entrypoint for the build project under `./build/Build.fsproj`.
69-
70-
:::info
71-
- **On Windows** you can also use `.\build.cmd` to run the build tasks instead of `dotnet run --project ./build/Build.fsproj`.
72-
- **On MacOS/Linux** you can also use `./build.sh` to run the build tasks instead of `dotnet run --project ./build/Build.fsproj`.
73-
:::
74-
75-
## Testing
76-
77-
```bash
78-
dotnet run --project ./build/Build.fsproj test
79-
```
80-
81-
## Run docs
82-
83-
1. Go into docs folder:
84-
85-
```bash
86-
cd docs
87-
```
88-
89-
2. Start docs server:
9015

91-
```bash
92-
npm run start
93-
```

src/Directory.Build.props

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<PrivateAssets>all</PrivateAssets>
1515
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
1616
</PackageReference>
17-
<None Include="$(MSBuildThisFileDirectory)\..\fable_logo.png" Pack="true" PackagePath="\" />
17+
<None Include="$(MSBuildThisFileDirectory)\..\build\fable_logo.png" Pack="true" PackagePath="\" />
1818
<None Include="$(MSBuildThisFileDirectory)\..\README.md" Pack="true" PackagePath="\"/>
1919
</ItemGroup>
2020
</Project>

0 commit comments

Comments
 (0)