Skip to content
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.

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

Allow organisers to leave a public comment with a release #772

Closed
rixx opened this issue Sep 11, 2019 · 3 comments
Closed

Allow organisers to leave a public comment with a release #772

rixx opened this issue Sep 11, 2019 · 3 comments
Labels
good first issue help wanted issue:feature size:small 🐁 stage:up for grabs 📤

Comments

@rixx
Copy link
Member

@rixx rixx commented Sep 11, 2019

This comment would then be shown next to the list of changes, probably before.

@rixx rixx added good first issue issue:feature size:small 🐁 stage:up for grabs 📤 labels Nov 25, 2019
@rixx rixx added this to the 2020 milestone Jan 13, 2020
@rixx
Copy link
Member Author

@rixx rixx commented Feb 25, 2020

This is an issue that is well-suited for external contributors – let me know if I can be of any help, either via this issue or via support@pretalx.com.

What this is about

pretalx allows organisers to schedule events, and then release public versions of these schedules. It would be great to be able to leave a note on these schedule changes.

How to get started

First of all, leave a comment on this issue to make sure nobody else starts working on this issue at the same time!

Next, you need pretalx running locally on your machine. First, fork the repository to your own GitHub account. Then clone it locally (or set it as your remote if you already cloned it earlier)

Follow the developer setup guide, and then play around with pretalx a bit.
Have a look at the places impacting this issue. Look at the code responsible for the issues (searching for relevant words or files should help you find your way around). We have an explanation of our code structure and the actual data models.

How to do this

The Schedule model is in pretalx/schedule/models/schedule.py. Add a new nullable field called comment, then create a migration with the makemigrations command, and apply it with the migrate command.

Next, you'll want to include this field in the organiser area when releasing a schedule. Add it to the fields list of pretalx.orga.forms.schedule.ScheduleReleaseForm, and include it in pretalx/orga/templates/orga/schedule/release.html.

Finally, make sure this text is shown in the public changelog (pretalx/agenda/templates/agenda/changelog.html) and RSS feed at pretalx/agenda/templates/agenda/feed/description.html.

Submit the PR

There are a number of tutorials on the Pull Request workflow online, for example this short version by GitHub itself and this more in-depth tutorial.

Remember to provide documentation and tests, if applicable. Run the tests before opening your PR, including style checks. We have a contribution guide, which ought to prove helpful at this stage.

@rixx rixx added the help wanted label Feb 25, 2020
@rahmonov
Copy link
Contributor

@rahmonov rahmonov commented Mar 21, 2020

Do you think it should be a CharField or a TextField?

I would think that comments should be a TextField. However the form kinda suggests that it should be a CharField because the form has an inline layout. Ignoring the styles, is the following something like you would expect?

image

@rixx
Copy link
Member Author

@rixx rixx commented Mar 21, 2020

Hmm, you're right, I'd suggest using an I18nTextField, and offering the input above the submit bar.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue help wanted issue:feature size:small 🐁 stage:up for grabs 📤
Projects
None yet
Development

No branches or pull requests

2 participants