Skip to content

Commit

Permalink
Merge pull request #18 from bedirhantong/bedirhantong-patch-1
Browse files Browse the repository at this point in the history
Create CONTRIBUTING.md
  • Loading branch information
bedirhantong authored Dec 1, 2023
2 parents 24ce014 + cf8c6e8 commit b2c4c7a
Showing 1 changed file with 88 additions and 0 deletions.
88 changes: 88 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# Contributing to Threads Clone

Thank you for considering contributing to Threads Clone! We welcome your suggestions, bug reports, and contributions to make this project better.

## Getting Started

1. Fork this repository.
2. Clone the forked repository to your local machine:

```bash
git clone https://github.com/your-username/threads_clone.git
```

3. Make and test your changes.
4. Create a pull request to submit your changes.

## Development Setup

To set up the development environment, follow these steps:

1. Install [Node.js](https://nodejs.org/) and [npm](https://www.npmjs.com/).
2. Navigate to the project directory:

```bash
cd threads_clone
```

3. Install dependencies:

```bash
npm install
```

4. Start the development server:

```bash
npm start
```

5. Open your browser and visit [http://localhost:3000](http://localhost:3000) to view the application.

## Making Changes

1. Create a new branch for your changes:

```bash
git checkout -b feature/my-feature
```

2. Make your changes and test thoroughly.

3. Commit your changes with a meaningful commit message:

```bash
git commit -m "Add feature: my feature description"
```

4. Push your branch to your fork:

```bash
git push origin feature/my-feature
```

5. Open a pull request against the main repository.

## Code Style

Please follow the coding conventions used in the existing codebase. Ensure your code is well-documented, and include tests for new features or bug fixes.

## Submitting a Pull Request

1. Open a pull request with a clear title and description.
2. Provide a summary of your changes and the motivation for them.
3. Ensure your code passes the automated tests.

## Issues

If you find any issues or have suggestions, please open an issue on the [Issues](https://github.com/bedirhantong/threads_clone/issues) page.

## Code of Conduct

Please review our [Code of Conduct](CODE_OF_CONDUCT.md) before participating in this project.

## License

By contributing to Threads Clone, you agree that your contributions will be licensed under the [MIT License](LICENSE).

Thank you for your contribution!

0 comments on commit b2c4c7a

Please sign in to comment.