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

Update README.md #76

Open
starbelly opened this issue Oct 20, 2019 · 5 comments
Open

Update README.md #76

starbelly opened this issue Oct 20, 2019 · 5 comments
Labels
help wanted Help Wanted

Comments

@starbelly
Copy link
Member

The README.md does not currently reflect the following:

  • contributing
  • generating events
  • generating news letters
@starbelly starbelly added the help wanted Help Wanted label Oct 20, 2019
@paulo-ferraz-oliveira
Copy link
Contributor

How's this for "contributing"? (I can pull request and tweak, if accepted)

(shamelessly adapted from https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

Contributing to erlef/website

We want to make contributing to this project as easy and transparent as possible.

Our Development Process

We use GitHub to sync code to and from our internal repository. We'll use GitHub to track issues and feature requests, as well as accept pull requests.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from develop.
  2. If you've added code that should be tested, add tests. (if in doubt, ask)
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. When contributing be sure to accept our required acknowledgement of non-favouritism.

Issues

We use GitHub issues to track public bugs and feature requests. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue, or describe the intended feature.

License

By contributing to erlef/website, you agree that your contributions will be licensed under its Apache License Version 2.0.

@starbelly
Copy link
Member Author

I like it! I'm thinking we should switch to main from develop though, thoughts? Also we don't have an internal repository.

@paulo-ferraz-oliveira
Copy link
Contributor

I'm not opposed to that change, though I like semantics where appropriate. Production is effectively the deployed stuff, right? So probably develop should become staging?

@starbelly
Copy link
Member Author

I think main can implicitly mean this should go on staging before production, but I'm not strongly tied to that idea either. I think I just like main because it's short :p It's also becoming a standard.

@paulo-ferraz-oliveira
Copy link
Contributor

I'm OK with either. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Help Wanted
Projects
None yet
Development

No branches or pull requests

2 participants