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

Delete / Cleanup Branches Not Following New Naming Convention, Add New Contribution Guidelines #351

Open
pwdel opened this issue Sep 29, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@pwdel
Copy link
Member

pwdel commented Sep 29, 2024

New Contribution Guidelines should be added here:

https://github.com/openpredictionmarkets/socialpredict/blob/main/CONTRIBUTING.md

This document should be linked from the main README.md in an appropriate table of content format.

Specifically, we need to communicate the new standard for branch naming. E.g. under point 3...

3. **Create a Branch**
   - Create a new branch in your local repository before starting your work.
   - Use a clear branch name that describes the intent of your work, such as `feature/add-login` or `fix/header-bug`.

However, we must include the allowed branch names.

To make this documentation evergreen, we could just point it to the workflows file on our backend:

startsWith(github.head_ref, 'feature/')

Currently, the following branches are allowed:

    if: |
      startsWith(github.head_ref, 'feature/')
      || startsWith(github.head_ref, 'fix/')
      || startsWith(github.head_ref, 'refactor/')
    runs-on: ubuntu-latest

That is:

feature, fix, refactor
@pwdel pwdel converted this from a draft issue Sep 29, 2024
@pwdel pwdel changed the title Delete / Cleanup Branches Not Following New Naming Convention Delete / Cleanup Branches Not Following New Naming Convention, Add New Contribution Guidelines Sep 29, 2024
@pwdel pwdel self-assigned this Sep 29, 2024
@pwdel pwdel added the documentation Improvements or additions to documentation label Oct 5, 2024
@astrosnat astrosnat self-assigned this Oct 5, 2024
@pwdel pwdel removed their assignment Oct 5, 2024
@pwdel pwdel linked a pull request Oct 5, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: UK Science Predictions or Kenyon Class
Development

Successfully merging a pull request may close this issue.

2 participants