-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e14bfb9
commit b31d54c
Showing
1 changed file
with
53 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,53 @@ | ||
# Contributing to RichSpan | ||
|
||
Thank you for considering contributing to RichSpan! We welcome your contributions to help improve this application. Please read this guide to understand how you can contribute effectively. | ||
|
||
## How to Contribute | ||
|
||
1. Fork the Repository: Start by forking the [RichSpan repository](https://github.com/berkaygediz/RichSpan) on GitHub to your account. | ||
|
||
2. Clone the Repository: Clone your forked repository to your local development environment. | ||
|
||
```bash | ||
git clone https://github.com/berkaygediz/RichSpan.git | ||
``` | ||
|
||
3. Create a Branch: Create a new branch for your contribution. Use a descriptive name for your branch. | ||
|
||
```bash | ||
git checkout -b feature/your-feature-name | ||
``` | ||
|
||
4. Make Changes: Make your changes and improvements to the codebase. Ensure that your code follows the project's coding style and conventions. | ||
|
||
5. Test Your Changes: Test your changes thoroughly to ensure they work as expected. Also, run the application and test your feature. | ||
|
||
6. Commit Your Changes: Commit your changes with a clear and concise commit message. | ||
|
||
```bash | ||
git commit -m "Add your commit message here" | ||
``` | ||
|
||
7. Push Your Changes: Push your changes to your fork on GitHub. | ||
|
||
```bash | ||
git push origin feature/your-feature-name | ||
``` | ||
|
||
8. Create a Pull Request: Visit the [RichSpan repository on GitHub](https://github.com/berkaygediz/RichSpan) and click on the "New Pull Request" button. Provide a descriptive title and description for your pull request. | ||
|
||
9. Review and Discuss: Your pull request will be reviewed by the project maintainers. Be prepared to address any feedback or changes requested during the review process. | ||
|
||
10. Merge: Once your pull request is approved, it will be merged into the main repository. Congratulations on your contribution! | ||
|
||
## Development Guidelines | ||
|
||
- Follow PEP 8 style guidelines for Python code. | ||
|
||
## Reporting Issues | ||
|
||
If you encounter any bugs, issues, or have suggestions for improvements, please [create an issue](https://github.com/berkaygediz/RichSpan/issues) on the GitHub repository. | ||
|
||
## Code of Conduct | ||
|
||
Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) to create a positive and inclusive environment for all contributors. |