doc: adding code of conduct
This commit is contained in:
54
README.md
54
README.md
@@ -129,7 +129,59 @@ This feature ensures you can start working in your preferred environment immedia
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! If you have ideas, feature requests, or find bugs, please submit an issue or a pull request.
|
||||
We welcome contributions to React Crafter! If you have ideas, find bugs, or want to improve the project, please feel free to contribute. Here's how you can get involved:
|
||||
|
||||
### 1. Fork the Repository
|
||||
Start by forking the repository to your own GitHub account:
|
||||
|
||||
1. Navigate to the [React Crafter GitHub repository](#).
|
||||
2. Click the "Fork" button in the top right corner.
|
||||
|
||||
### 2. Clone Your Fork
|
||||
Clone your forked repository to your local machine:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/your-username/react-crafter.git
|
||||
cd react-crafter
|
||||
```
|
||||
|
||||
### 3. Create a New Branch
|
||||
Create a new branch for your feature or bug fix:
|
||||
|
||||
```bash
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
|
||||
### 4. Make Changes
|
||||
Make your changes or improvements in your new branch. Follow the existing code style and conventions.
|
||||
|
||||
### 5. Test Your Changes
|
||||
Before submitting your changes, make sure everything works as expected:
|
||||
|
||||
```bash
|
||||
npm run test
|
||||
```
|
||||
|
||||
### 6. Commit and Push
|
||||
Commit your changes with a descriptive commit message:
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "Add new feature: your-feature-name"
|
||||
git push origin feature/your-feature-name
|
||||
```
|
||||
|
||||
### 7. Create a Pull Request
|
||||
Go to the original repository and click on the "Pull Requests" tab. Click "New Pull Request" and select your branch. Provide a description of your changes and submit the pull request.
|
||||
|
||||
### 8. Review Process
|
||||
Your pull request will be reviewed by the maintainers. You may be asked to make additional changes or clarifications before your code is merged.
|
||||
|
||||
### 9. Celebrate 🎉
|
||||
Once your pull request is merged, you’ve officially contributed to React Crafter! Thank you for your contribution.
|
||||
|
||||
### Code of Conduct
|
||||
Please note that we have a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [cargdev@gmail.com](mailto:cargdev@gmail.com).
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user