Skip to content

Commit 1025d76

Browse files
authored
Update CONTRIBUTING.md
1 parent 40485c2 commit 1025d76

File tree

1 file changed

+3
-13
lines changed

1 file changed

+3
-13
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
# CONTRIBUTING
22

3-
Hi, welcome to hic et nunc repository. We're happy you're here.
4-
5-
We're trying to optimize the source code little by little, and it is only fair to write some notes on the thinking behind why we're making some of the decisions we're making. Writing this down will help you (the contributor) get comfortable with the source code.
6-
7-
## Testing
8-
9-
We're currently implementing [Storybook](https://storybook.js.org/) which will be the ideal place where you can check how the components look. We're also currently implementing basic unit testing using [Jest](https://jestjs.io/).
10-
113
## Components
124

135
When creating a component you need to provide a few properties in order to render the component properly. Try to avoid creating prop drilling, or even accessing react context in a component. The components should be as dumb as possible. The only place where you should have access to API requests, or React.Context is at the page level (`src/pages/*`).
@@ -28,10 +20,8 @@ There are some auxiliary components that aren't doing much besides aiding with t
2820

2921
## PR
3022

31-
Pull requests should be as small as possible. At the moment there are a lot of eslint errors everywhere, and instead of fixing them all in one go (potentially breaking something and not being able to identify exactly what broke it), we're deciding to go page by page, component by component, fixing those warnings, removing unused code, etc.
32-
33-
Because it's been a very small team contributing to this project, we've been mainly contributing directly into the `main` branch, but that won't happen anymore.
23+
We take PRs on a case-by-case basis. Please contact us in the discord in the #dev channel to have your PR considered.
3424

35-
We will be using a Git flow approach. This means that you will need to create a feature branch from the `develop` branch, write all your code there, and then when you submit your PR you submit it against the `develop` branch. Once the features on `develop` are tested and ready to push to production, an Admin will create a PR from `develop` to `main` and kick off a deployment.
25+
You will need to create a feature branch from the `main` branch, write all your code there, and then when you submit your PR you submit it against the `main` branch.
3626

37-
If Git flow is something new to you, don't feel intimidated, come and join us on Discord and we'll take the time to help.
27+
If anything else is new to you, don't feel intimidated, come and join us on Discord and we'll take the time to help.

0 commit comments

Comments
 (0)