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

Improvements needed in Contribute section of README #66

Open
shashaBot opened this issue Oct 18, 2018 · 1 comment
Open

Improvements needed in Contribute section of README #66

shashaBot opened this issue Oct 18, 2018 · 1 comment
Labels

Comments

@shashaBot
Copy link

The contribute section of README is highly lacking. The steps demonstrate how to run the application with the current state of the repo but doesn't help very much with contribution part. For example, it doesn't include how to make the changes and making a pull request from the contributor's fork (I think that's the model being followed).

Opening this issue to discuss how to approach this. We can go multiple ways: improving the section under README or creating a new CONTRIBUTING doc with more extensive branch policies, pull request template.

@poush
Copy link
Owner

poush commented Oct 18, 2018

Inspiration can be taken from: https://github.com/fossasia/open-event-server#contributions-best-practices

parent issue: #36

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

No branches or pull requests

2 participants