-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: contributing.md guide&lines (#10)
- Loading branch information
1 parent
467a297
commit 5aa89ef
Showing
1 changed file
with
118 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
# Contributing to Quibble | ||
|
||
Thank you for your interest in contributing to Quibble! We’re excited to build a respectful and engaging platform together. Please follow these guidelines to make the process smooth and efficient. | ||
|
||
## Getting Started | ||
|
||
1. **Fork the Repository** | ||
Start by forking the [Quibble repository](https://github.com/quibble-dev/Quibble). | ||
|
||
2. **Clone Your Fork** | ||
```bash | ||
git clone https://github.com/your-username/Quibble.git | ||
cd Quibble | ||
``` | ||
|
||
3. **Set Up Environment** | ||
Install the required tools for both the backend and frontend. | ||
|
||
## Project Structure | ||
|
||
- **`backend/`** - Django application managed with Poetry. | ||
- **`frontend-next/`** - Next.js frontend managed with npm. | ||
|
||
## Setting Up the Backend (Django) | ||
|
||
1. **Navigate to the Backend Directory** | ||
```bash | ||
cd backend | ||
``` | ||
|
||
2. **Install Dependencies with Poetry** | ||
```bash | ||
poetry install | ||
``` | ||
|
||
3. **Set Up Environment Variables** | ||
Copy `.env.example` to `.env` and update environment variables as needed. | ||
|
||
4. **Run Database Migrations** | ||
```bash | ||
poetry run python manage.py migrate | ||
``` | ||
|
||
5. **Start the Development Server** | ||
```bash | ||
poetry run python manage.py runserver | ||
``` | ||
|
||
## Setting Up the Frontend (Next.js) | ||
|
||
1. **Navigate to the Frontend Directory** | ||
```bash | ||
cd frontend-next | ||
``` | ||
|
||
2. **Install Dependencies** | ||
```bash | ||
npm install | ||
``` | ||
|
||
3. **Run the Development Server** | ||
```bash | ||
npm run dev | ||
``` | ||
|
||
## Making Changes | ||
|
||
1. **Create a New Branch** | ||
```bash | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
2. **Make Changes** | ||
Ensure your changes adhere to the project’s coding standards. | ||
|
||
3. **Lint and Format Your Code** | ||
- For the backend, ensure your code meets PEP8 standards. | ||
- For the frontend, use ESLint and Prettier. | ||
|
||
4. **Write Tests** | ||
Aim to write tests for any new functionality. | ||
|
||
5. **Run Tests** | ||
- **Backend**: Run tests with `poetry run pytest` | ||
- **Frontend**: Run tests with `npm test` | ||
|
||
6. **Commit Your Changes** | ||
Use meaningful commit messages: | ||
```bash | ||
git commit -m "Add feature description" | ||
``` | ||
|
||
7. **Push Your Changes** | ||
```bash | ||
git push origin feature/your-feature-name | ||
``` | ||
|
||
## Submitting a Pull Request | ||
|
||
1. **Open a Pull Request** | ||
Go to the Pull Requests tab on GitHub and open a new PR. | ||
|
||
2. **Describe Your Changes** | ||
Clearly describe the changes you made and link any relevant issues. | ||
|
||
3. **Request a Review** | ||
Tag project maintainers or team members for a review. | ||
|
||
## Code of Conduct | ||
|
||
Please respect others and foster a welcoming environment. We expect all contributors to adhere to the [Code of Conduct](https://github.com/quibble-dev/Quibble/blob/main/CODE_OF_CONDUCT.md). | ||
|
||
## Additional Notes | ||
|
||
- **Documentation**: Ensure new features or changes are documented. | ||
- **Commit Hygiene**: Keep your commit history clean; squash commits if necessary. | ||
|
||
Thank you for contributing to Quibble! We look forward to your input. |