Skip to content

Commit 61843ae

Browse files
authored
Merge pull request #42 from sujeetgund/main
#4 - CONTRIBUTING.md file created
2 parents 3ec0861 + 4cf4b31 commit 61843ae

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

CONTRIBUTING.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via [issues](https://github.com/webdevcody/code-racer/issues), [discord](https://discord.gg/4kGbBaa).
4+
5+
Please note if you are working on a certain issue then make sure to stay active with development.
6+
7+
## Contribution Process
8+
9+
1. Get started with these [instructions](https://github.com/webdevcody/code-racer#installation) to get code on your local machine.
10+
2. Check open issues or start an issue to work within.
11+
*Note: when starting an issue, first check if there is already same issue exists and then discuss on discord server.*
12+
13+
4. Checkout a new branch
14+
5. Do your work. Save changes and commit.
15+
6. Push your branch to your fork.
16+
7. Go into github UI and create a PR from your fork & branch, and merge it into upstream MAIN
17+
18+
19+
## Code of Conduct
20+
21+
### Our Pledge
22+
23+
In the interest of fostering an open and welcoming environment, we as
24+
contributors and maintainers pledge to making participation in our project and
25+
our community a friendly experience for everyone, regardless of any experience to give everyone an opportunity to contribute in this project.
26+
27+
### Our Responsibilities
28+
29+
The primary responsibility of contributors is to provide high-quality code contributions to the project. This involves writing, reviewing, and submitting code changes that improve the project's functionality, fix bugs, or implement new features.
30+
31+
Contributors should actively participate in project discussions and communicate effectively with other contributors, maintainers, and users. This includes joining [discord](https://discord.gg/4kGbBaa) server solely created for this project.
32+
33+
Contributors can play a role in the long-term maintenance of the project by actively monitoring the project's issue tracker, addressing bug reports and feature requests, and collaborating with other contributors to ensure the project remains healthy and sustainable.
34+
35+
### Scope
36+
37+
This Code of Conduct applies both within project spaces and in public spaces
38+
when an individual is representing the project or its community. Examples of
39+
representing a project or community include using an official project e-mail
40+
address, posting via an official social media account, or acting as an appointed
41+
representative at an online or offline event. Representation of a project may be
42+
further defined and clarified by project maintainers.
43+

0 commit comments

Comments
 (0)