-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Contributing Guide and Project Setup Guide (#21)
* fixed: Responsiveness - volunteer and ticket button * feat: contributing guide * Added cloning steps * local dev/ setup instructions in readme
- Loading branch information
Showing
2 changed files
with
98 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,80 @@ | ||
Thank you for taking the time to contribute to Pycon India 2024 Website. | ||
|
||
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. | ||
|
||
> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: | ||
> - Join our [Zulip Chat](https://pyconindia.zulipchat.com/) | ||
> - Star the project | ||
> - Tweet about it | ||
> - Mention the project at local meetups and tell your friends/colleagues | ||
## Table of Contents | ||
- [I Want To Contribute](#i-want-to-contribute) | ||
- [I Have a Question](#i-have-a-question) | ||
- [Reporting Bugs](#reporting-bugs) | ||
- [Suggesting Enhancements](#suggesting-enhancements) | ||
- [Your First Code Contribution](#your-first-code-contribution) | ||
- [Improving The Documentation](#improving-the-documentation) | ||
|
||
## I Want To Contribute | ||
First off, thank you for taking the time to contribute! It's people like you that make PyCon India such a great Conference. There are many ways to contribute, from submitting bug reports and feature requests or writing code which can be incorporated into the website itself. We welcome all contributions, no matter how big or small. We try to make it as easy as possible, but there are some things to keep in mind when contributing to PyCon India 2024 Website. | ||
|
||
You can go through the existing issues and pick one that interests you. If you have an idea for a new feature or want to report a bug, please [open an issue](#reporting-bugs) first. This way we can discuss the details and figure out whether it's a good fit for the project and how to implement it. If you have any questions, feel free to [ask them](#i-have-a-question) as well. | ||
|
||
## I Have a Question | ||
If you have any questions about the website, please open an issue or drop it in our [Zulip Chat](https://pyconindia.zulipchat.com/). We will try to answer it as soon as possible. | ||
|
||
## Reporting Bugs | ||
This section guides you through submitting a bug report for the website. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior and find related reports. | ||
Before creating bug reports, please check the [open issues](https://github.com/pythonindia/inpycon2024/issues) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out [the required template](#bug-report-template), the information it asks for helps us resolve issues faster. | ||
|
||
### How Do I Submit A (Good) Bug Report? | ||
Bugs are tracked as [GitHub issues](https://github.com/pythonindia/inpycon2024/issues). Create an issue on that and provide the following information by filling in [the template](#bug-report-template). | ||
|
||
#### Bug Report Template | ||
```markdown | ||
## Description | ||
A clear and concise description of what the bug is. | ||
|
||
## Steps To Reproduce | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
## Expected Behavior | ||
A clear and concise description of what you expected to happen. | ||
|
||
## Screenshots | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
## Additional Context | ||
Add any other context about the problem here. | ||
``` | ||
## Suggesting Enhancements | ||
This section guides you through submitting an enhancement suggestion for the website, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions. | ||
Before creating enhancement suggestions, please check the [open issues](https://github.com/pythonindia/inpycon2024/issues) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill in [the template](#enhancement-suggestion-template), including the steps that you imagine you would take if the feature you're requesting existed. | ||
|
||
### How Do I Submit A (Good) Enhancement Suggestion? | ||
Enhancement suggestions are tracked as [GitHub issues](https://github.com/pythonindia/inpycon2024/issues). Create an issue on that repository and provide the following information by filling in [the template](#enhancement-suggestion-template): | ||
|
||
#### Enhancement Suggestion Template | ||
```markdown | ||
## Description | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
## Solution | ||
A clear and concise description of what you want to happen. | ||
|
||
## Alternatives | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
## Additional Context | ||
Add any other context or screenshots about the enhancement suggestion here. | ||
``` | ||
## Your First Code Contribution | ||
Unsure where to begin contributing to Pycon India 2024 Website? You can start by looking through these [good-first-issues](https://github.com/pythonindia/inpycon2024/labels/good%20first%20issue). | ||
|
||
### Pull Requests | ||
After you have made your changes, you can open a pull request. Make sure to [link the issue](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) you are addressing in the pull request description. This helps us keep track of the changes and the discussion around them. If you are adding a new feature, please include relevant tests and make sure that all tests pass before submitting the pull request. |
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