100 lines
3.0 KiB
Markdown
100 lines
3.0 KiB
Markdown
# Contributing to Jargon File Explorer
|
|
|
|
Welcome to the Jargon File Explorer project! We're excited that you're interested in contributing. This guide will help you get started with contributing to the project.
|
|
|
|
## Table of Contents
|
|
- [Code of Conduct](#code-of-conduct)
|
|
- [How to Contribute](#how-to-contribute)
|
|
- [Reporting Bugs](#reporting-bugs)
|
|
- [Suggesting Enhancements](#suggesting-enhancements)
|
|
- [Development Setup](#development-setup)
|
|
- [Pull Request Process](#pull-request-process)
|
|
- [Style Guides](#style-guides)
|
|
- [Additional Resources](#additional-resources)
|
|
|
|
## Code of Conduct
|
|
|
|
This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
|
|
|
|
## How to Contribute
|
|
|
|
There are many ways to contribute to this project:
|
|
- Reporting bugs
|
|
- Suggesting enhancements
|
|
- Writing or improving documentation
|
|
- Writing code
|
|
- Submitting pull requests
|
|
|
|
## Reporting Bugs
|
|
|
|
Bugs are tracked as GitHub issues. Before submitting a bug report, please:
|
|
|
|
1. Check if the issue has already been reported
|
|
2. Ensure you're using the latest version of the application
|
|
3. Provide a clear description of the problem
|
|
4. Include steps to reproduce the issue
|
|
5. Include any relevant error messages or screenshots
|
|
|
|
## Suggesting Enhancements
|
|
|
|
Enhancement suggestions are also tracked as GitHub issues. Before submitting an enhancement:
|
|
|
|
1. Check if the enhancement has already been suggested
|
|
2. Clearly describe the enhancement
|
|
3. Explain why it would be useful
|
|
4. If possible, include mockups or examples
|
|
|
|
## Development Setup
|
|
|
|
### Prerequisites
|
|
- Node.js (version 14 or higher)
|
|
- npm (usually comes with Node.js)
|
|
|
|
### Installation
|
|
1. Fork the repository
|
|
2. Clone your fork:
|
|
```bash
|
|
git clone https://github.com/YOUR_USERNAME/jargon-file-explorer.git
|
|
cd jargon-file-explorer
|
|
```
|
|
|
|
3. Install dependencies:
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
4. Start the development server:
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
## Pull Request Process
|
|
|
|
1. Ensure any install or build dependencies are removed before the end of the layer when doing a build
|
|
2. Update the README.md with details of changes to the interface, including new environment variables, exposed ports, useful file locations and container parameters
|
|
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent
|
|
4. You may merge the Pull Request in once the code review is complete, the CI/CD pipeline has passed, and you have the sign-off of other maintainers
|
|
|
|
## Style Guides
|
|
|
|
### JavaScript
|
|
- Use functional components with hooks
|
|
- Follow React best practices
|
|
- Write clean, readable code
|
|
- Include comments for complex logic
|
|
|
|
### CSS
|
|
- Use CSS Modules for component styling
|
|
- Follow a consistent naming convention (BEM or similar)
|
|
- Ensure responsive design
|
|
|
|
### Documentation
|
|
- Write clear and concise documentation
|
|
- Use consistent formatting
|
|
- Update documentation when making changes
|
|
|
|
## Additional Resources
|
|
|
|
- [Project Plan](PROJECT_PLAN.md)
|
|
- [Technical Specification](REACT_APP_SPEC.md)
|
|
- [Developer Documentation](DEVELOPER_DOCS.md) |