Skip to content

Commit 1696388

Browse files
authored
Update CONTRIBUTING.md
1 parent 10524f8 commit 1696388

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,36 @@ pnpm dev
2929

3030
### Contribution Guide
3131

32+
## How to Contribute
33+
34+
1. **Clone the Repository**
35+
- Visit our GitHub repository and clone it to your local environment.
36+
37+
2. **Create a New Branch**
38+
- Create a branch for your contribution.
39+
- Ensure your feature branch is associated with the corresponding GitHub issue from our Jira page at gelecekbilimde.atlassian.net/jira
40+
41+
3. **Make Changes**
42+
- Implement your changes in the branch you created.
43+
- Thoroughly test your changes to ensure they work as expected.
44+
45+
4. **Commit Changes**
46+
- Commit your changes with clear and concise messages.
47+
48+
5. **Push Changes**
49+
- Push your changes to your forked repository.
50+
51+
6. **Open a Pull Request (PR)**
52+
- Open a PR against the main branch of the original repository.
53+
- Provide a detailed description of your changes in the PR.
54+
- Link relevant issues or discussions in the PR description.
55+
56+
7. **Review and Feedback**
57+
- Once your PR is submitted, project maintainers will review it and provide feedback.
58+
- Be responsive to feedback and make necessary changes.
59+
60+
For additional information, our documents can be found on our Confluence page. If you're interested in leading development on an issue and becoming part of our volunteer IT team, you can apply via gelecekbilimde.net/basvur. For feature requests, feel free to mention them in the discussions section.
61+
3262
It is recommended to use **Visual Studio Code** as the editor. It has extension support for **TypeScript**, **ESLint**, and **Prettier**. To install the recommended extensions for the project, you can press **Ctrl+Shift+P** and type **Extensions: Show Recommended Extensions**.
3363

3464
> The **Prettier** extension is optional because it is already integrated with **lint-staged** and **husky**. The code will be automatically formatted before committing.

0 commit comments

Comments
 (0)