-
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
Showing
1 changed file
with
34 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,34 @@ | ||
# Contributing to Ascii-Table | ||
Thank you for considering contributing to [Your Project Name]! We welcome contributions from everyone, regardless of experience level. By participating in this project, you agree to abide by our [Code of Conduct](./CODE_OF_CONDUCT.md). | ||
|
||
## How Can I Contribute? | ||
There are several ways you can contribute to this project: | ||
|
||
1. Reporting Bugs: If you encounter a bug while using ascii-Table, please [open an issue](https://github.com/ManojTGN/ascii-table/issues/new/choose) and provide detailed information about the bug, including steps to reproduce it. | ||
2. Suggesting Enhancements: If you have ideas for new features or improvements to existing features, please [open an issue](https://github.com/ManojTGN/ascii-table/issues/new/choose) and describe your suggestion. We welcome feedback and ideas from the community! | ||
3. Writing Documentation: Good documentation is crucial for the success of any project. If you notice areas where the documentation could be improved or if you're interested in writing new documentation, feel free to submit a pull request with your changes. | ||
|
||
4. Fixing Bugs: If you're comfortable diving into the code, you can look for open issues labeled as "bug" and submit a pull request with a fix and write tests for your changes. | ||
5. Implementing Features: Similarly, if you're interested in working on new features, you can look for open issues labeled as "enhancement" and submit a pull request with your implementation. Coordinate with the maintainers to ensure that your proposed changes align with the project's goals. | ||
|
||
## Getting Started | ||
To get started contributing to Ascii-Table, follow these steps: | ||
|
||
1. Fork the repository and clone it to your local machine. | ||
3. Make your changes and commit them: `git commit -m "Add new feature"`. | ||
4. Push your changes to your fork: `git push origin my-contribution`. | ||
5. Submit a pull request with a description of your changes. `that simple ;)` | ||
|
||
## Code Style Guidelines | ||
When contributing code to this project, please follow these guidelines: | ||
|
||
- Use consistent coding style throughout the project. | ||
- Write clear and concise code that is easy to understand and maintain. | ||
- Include comments to explain your code where necessary. | ||
- Write descriptive commit messages that clearly explain the purpose of each commit. | ||
|
||
## Code Review Process | ||
All contributions to this project will go through a code review process to ensure the quality and maintainability of the codebase. The maintainers will review your pull request and provide feedback. Once your changes are approved, they will be merged into the main branch. | ||
|
||
## Contact | ||
If you have any questions or need further assistance, please feel free to reach out to us via [email](mailto:[email protected]) or [open an issue](https://github.com/ManojTGN/ascii-table/issues/new/choose). We're here to help! |