Skip to content

Latest commit

 

History

History
99 lines (61 loc) · 3.23 KB

index.rst

File metadata and controls

99 lines (61 loc) · 3.23 KB

Contributing

This respository houses Flux constitutions and internal policies.

You are welcome to make a pull request but please be aware there are governance procedures around accepting changes to our constitutions and policies that require certain sign-offs.

Please don't be surprised if a PR you submit is not accepted. A good path to having a PR be accepted is to first create an issue to state your case and discuss publicly the need for the change and how it could be sensibly implemented. Also please keep in mind that we've avoided some things for good reason, though feel free to ask about anything you consider important that we've either overlooked or seem to have rejected or avoided in the past.

Also, in regards to discussion, please make liberal use of quoting since comments can be edited after the fact and to avoid ambiguety. Please do not be surprised if you are asked to make use of quotes in your discussion posts. Good quoting is incredibly important, and paraphrasing other people or misquoting them (deliberately or accidentally) is taken quite seriously.

Editing files and making a pull request

Find a mistake or figure out what you want to edit

find a mistake

find a mistake

Then click edit

(Make sure you’re viewing the file itself)

click edit in top right

click edit in top right

Make your changes

find the mistake

find the mistake

change what needs to be changed

change what needs to be changed

Commit changes

Make sure you select “Create a new branch for this commit and start a pull request” if the option is available.

commit changes

commit changes

Type in a message and click “Propose file change”

Add any details to the pull request if you need to - then create pull request

fill in pull request details

fill in pull request details

Click “create pull request”

Pull request created! you’ll be automatically emailed if anyone comments or mentions you on the pull request

pull request created

pull request created

Look in the “Files changed” tab to see changes (optional)

files changed

files changed

Once your PR (pull request) has been accepted you’ll see this and can delete the branch you made the edit on

pr accepted

pr accepted

Your changes will be live

changes live

changes live