Skip to content

Commit

Permalink
upgraded repository CONTRIBUTING.md (#201)
Browse files Browse the repository at this point in the history
* upgraded repository CONTRIBUTING.md

* wrote about
     * `How to Contribute`
     * `Issue Submission Guidelines`
     * `PR Submission Gudelines`
* added code of conduct link to CONTRIBUTING.md

* formatted with prettier

* Update CONTRIBUTING.md
  • Loading branch information
nh916 authored Jul 20, 2023
1 parent a67c793 commit 25dc785
Showing 1 changed file with 45 additions and 6 deletions.
51 changes: 45 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,42 @@ For more detailed information, please refer to our wiki section.

## How to Contribute

1. Fork the repository to your GitHub account.
1. Fork the repository [develop branch](https://github.com/C-Accel-CRIPT/Python-SDK/tree/develop) to your GitHub
account.
> [main branch](https://github.com/C-Accel-CRIPT/Python-SDK/tree/main) tries to mirror the CRIPT Pypi package,
> [develop branch](https://github.com/C-Accel-CRIPT/Python-SDK/tree/develop) has all the latest developments waiting
> for release
2. Create a new branch in your forked repository. Choose a descriptive name that summarizes your contribution.
3. Make the necessary changes or additions to the codebase.
4. Test your changes thoroughly to ensure they don't introduce any issues.
5. Commit your changes with a clear and concise commit message.
6. Push the changes to your forked repository.
7. Open a pull request (PR) in our repository to propose your changes.
> Please be sure to merge all of your incoming changes to the
> [develop branch](https://github.com/C-Accel-CRIPT/Python-SDK/tree/develop), we only update the
> [main branch](https://github.com/C-Accel-CRIPT/Python-SDK/tree/main) when going to make a release by
> merging [develop branch](https://github.com/C-Accel-CRIPT/Python-SDK/tree/develop) into main.
> For more information, please refer to
> [repository guidelines wiki](https://github.com/C-Accel-CRIPT/Python-SDK/wiki/Repository-Guidelines)
> and [deployment wiki](https://github.com/C-Accel-CRIPT/Python-SDK/wiki/Manually-Deploy-to-Pypi)
## Submitting an Issue

Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists, and the
discussion might inform you of workarounds readily available.

We want to fix all the issues as soon as possible, but before fixing a bug, we need to reproduce and confirm it. In
order to reproduce bugs, we will systematically ask you to provide a minimal reproduction scenario using the custom
issue template. Please stick to the issue template.

Unfortunately, we are not able to investigate/fix bugs without a minimal reproduction scenario, so if we don't hear
back from you, we may close the issue.

## Submitting PR

Search GitHub for an open or closed PR that relates to your submission. You
don't want to duplicate effort. If you do not find a related issue or PR,
go ahead.

## PR Guidelines

Expand All @@ -24,21 +53,31 @@ When submitting a pull request, please make sure to:
- Make sure your changes adhere to our coding style and guidelines.
- Test your changes thoroughly and provide any necessary documentation or test cases.
- Ensure your PR does not include any unrelated or unnecessary changes.
- All CI must pass before a PR can be approved and merged into the code base.

## Repositorty Wiki

For more in-depth information about our project, development setup, coding conventions, and specific areas where you can contribute, please refer to our [wiki section](https://github.com/C-Accel-CRIPT/Python-SDK/wiki).
For more in-depth information about our project, development setup, coding conventions, and specific areas where you can
contribute,
please refer to our [wiki section](https://github.com/C-Accel-CRIPT/Python-SDK/wiki).
It contains valuable resources and documentation to help you understand our project better.

We encourage you to explore the wiki before making contributions. It will provide you with the necessary background knowledge and help you find areas where your expertise can make a difference.
We encourage you to explore the wiki before making contributions. It will provide you with the necessary background
knowledge and help you find areas where your expertise can make a difference.

## Communication

If you have any questions, concerns, or need clarification on anything related to the project or your contributions, feel free to reach out to us.
You can use the [GitHub issue tracker](https://github.com/C-Accel-CRIPT/Python-SDK/issues) or the [Discussion channels](https://github.com/C-Accel-CRIPT/Python-SDK/discussions).
If you have any questions, concerns, or need clarification on anything related to the project or your contributions,
feel free to reach out to us.
You can use the [GitHub issue tracker](https://github.com/C-Accel-CRIPT/Python-SDK/issues) or
the [Discussion channels](https://github.com/C-Accel-CRIPT/Python-SDK/discussions).

## Code of Conduct

We expect all contributors to adhere to our code of conduct, which ensures a safe and inclusive environment for everyone. Please review our code of conduct before making contributions.
We expect all contributors to adhere to our
[code of conduct](https://github.com/C-Accel-CRIPT/Python-SDK/blob/develop/CODE_OF_CONDUCT.md),
which ensures a safe and inclusive environment for everyone.
Please review our [code of conduct](https://github.com/C-Accel-CRIPT/Python-SDK/blob/develop/CODE_OF_CONDUCT.md)
before making contributions.

Thank you for considering contributing to our project! We appreciate your time and effort in making it better.

0 comments on commit 25dc785

Please sign in to comment.