Skip to content

create a contributing.md #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ashishranjan2404 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

create a contributing.md #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Contributing to Heph

Thank you for considering contributing to Heph! We welcome contributions from anyone, regardless of their level of experience or expertise. This document outlines the process for contributing to the project.

## Getting Started

To get started contributing to Heph, follow these steps:

1. Fork the repository on GitHub.
2. Clone your fork of the repository to your local machine.
3. Create a new branch for your contribution.
4. Make your changes to the codebase.
5. Write tests to cover your changes.
6. Ensure that all tests pass.
7. Submit a pull request to the main repository.

## Coding Standards

We aim to maintain a high standard of code quality in Heph. When making contributions, please adhere to the following coding standards:

- Use idiomatic Go code.
- Follow the conventions in the existing codebase.
- Write clear, concise, and readable code.
- Document your code using GoDoc conventions.
- Use appropriate variable and function names.

## Testing

We take testing seriously in Heph. When making contributions, please ensure that you have written appropriate tests to cover your changes. These tests should:

- Test all edge cases.
- Be easily understandable by others.
- Be thorough and cover all aspects of your contribution.

## Submitting a Pull Request

When submitting a pull request, please follow these guidelines:

1. Ensure that your code adheres to the coding standards outlined above.
2. Ensure that you have written appropriate tests to cover your changes.
3. Include a clear and concise description of your changes.
4. Ensure that all tests pass.
5. Keep your pull request focused on a single issue or feature.

## Code of Conduct

We strive to maintain a welcoming and inclusive community in Heph. As such, we expect all contributors to abide by the following code of conduct:

- Treat others with respect and kindness.
- Do not engage in harassment, discrimination, or any other form of offensive behavior.
- Be patient and helpful to others.
- Follow the guidelines in this document and in the README.

## Conclusion

Thank you for considering contributing to Heph. Your contributions are valuable and we appreciate your time and effort. If you have any questions or concerns, please do not hesitate to reach out to us on GitHub or on our Gitter channel.